blob: 2d4f076d99915a64aaf8418c3c4f5f40990ad3c0 [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
Denys Vlasenko278842d2014-07-15 15:06:54 +020032//usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l -I IFACE")"] [-S PROG] [-p PEER]..."
Pere Orga5bc8c002011-04-11 03:29:49 +020033//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"
Denys Vlasenko278842d2014-07-15 15:06:54 +020042//usage: "\n -I IFACE Bind server to IFACE, implies -l"
Pere Orga5bc8c002011-04-11 03:29:49 +020043//usage: )
44//usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins"
45//usage: "\n -p PEER Obtain time from PEER (may be repeated)"
Denys Vlasenko504fe452014-03-23 15:06:38 +010046//usage: IF_FEATURE_NTPD_CONF(
47//usage: "\n If -p is not given, read /etc/ntp.conf"
48//usage: )
49
50// -l and -p options are not compatible with "standard" ntpd:
51// it has them as "-l logfile" and "-p pidfile".
52// -S and -w are not compat either, "standard" ntpd has no such opts.
Pere Orga5bc8c002011-04-11 03:29:49 +020053
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010054#include "libbb.h"
55#include <math.h>
56#include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
Mike Frysingerc5fe9f72012-07-05 23:19:09 -040057#include <sys/resource.h> /* setpriority */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010058#include <sys/timex.h>
59#ifndef IPTOS_LOWDELAY
60# define IPTOS_LOWDELAY 0x10
61#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010062
63
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010064/* Verbosity control (max level of -dddd options accepted).
Denys Vlasenkoa14958c2013-12-04 16:32:09 +010065 * max 6 is very talkative (and bloated). 3 is non-bloated,
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010066 * production level setting.
67 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +010068#define MAX_VERBOSE 3
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010069
70
Denys Vlasenko65d722b2010-01-11 02:14:04 +010071/* High-level description of the algorithm:
72 *
73 * We start running with very small poll_exp, BURSTPOLL,
Leonid Lisovskiy894ef602010-10-20 22:36:51 +020074 * in order to quickly accumulate INITIAL_SAMPLES datapoints
Denys Vlasenko65d722b2010-01-11 02:14:04 +010075 * for each peer. Then, time is stepped if the offset is larger
76 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
77 * poll_exp to MINPOLL and enter frequency measurement step:
78 * we collect new datapoints but ignore them for WATCH_THRESHOLD
79 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
80 * offset and estimate frequency drift.
81 *
Denys Vlasenko5b9a9102010-01-17 01:05:58 +010082 * (frequency measurement step seems to not be strictly needed,
83 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
84 * define set to 0)
85 *
Denys Vlasenko65d722b2010-01-11 02:14:04 +010086 * After this, we enter "steady state": we collect a datapoint,
87 * we select the best peer, if this datapoint is not a new one
88 * (IOW: if this datapoint isn't for selected peer), sleep
89 * and collect another one; otherwise, use its offset to update
90 * frequency drift, if offset is somewhat large, reduce poll_exp,
91 * otherwise increase poll_exp.
92 *
93 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
94 * happen, we assume that something "bad" happened (computer
95 * was hibernated, someone set totally wrong date, etc),
96 * then the time is stepped, all datapoints are discarded,
97 * and we go back to steady state.
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +010098 *
99 * Made some changes to speed up re-syncing after our clock goes bad
100 * (tested with suspending my laptop):
101 * - if largish offset (>= STEP_THRESHOLD * 8 == 1 sec) is seen
102 * from a peer, schedule next query for this peer soon
103 * without drastically lowering poll interval for everybody.
104 * This makes us collect enough data for step much faster:
105 * e.g. at poll = 10 (1024 secs), step was done within 5 minutes
106 * after first reply which indicated that our clock is 14 seconds off.
107 * - on step, do not discard d_dispersion data of the existing datapoints,
108 * do not clear reachable_bits. This prevents discarding first ~8
109 * datapoints after the step.
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100110 */
111
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100112#define INITIAL_SAMPLES 4 /* how many samples do we want for init */
113#define BAD_DELAY_GROWTH 4 /* drop packet if its delay grew by more than this */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100114
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200115#define RETRY_INTERVAL 32 /* on send/recv error, retry in N secs (need to be power of 2) */
116#define NOREPLY_INTERVAL 512 /* sent, but got no reply: cap next query by this many seconds */
117#define RESPONSE_INTERVAL 16 /* wait for reply up to N secs */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100118
119/* Step threshold (sec). std ntpd uses 0.128.
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200120 * Using exact power of 2 (1/8) results in smaller code
121 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100122#define STEP_THRESHOLD 0.125
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200123/* Stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
124#define WATCH_THRESHOLD 128
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100125/* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100126//UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100127
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200128/*
129 * If we got |offset| > BIGOFF from a peer, cap next query interval
130 * for this peer by this many seconds:
131 */
132#define BIGOFF (STEP_THRESHOLD * 8)
133#define BIGOFF_INTERVAL (1 << 7) /* 128 s */
134
Denys Vlasenko12628b72010-01-11 01:31:59 +0100135#define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
Denys Vlasenkofb132e42010-10-29 11:46:52 +0200136#define BURSTPOLL 0 /* initial poll */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100137#define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200138/*
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200139 * If offset > discipline_jitter * POLLADJ_GATE, and poll interval is > 2^BIGPOLL,
140 * then it is decreased _at once_. (If <= 2^BIGPOLL, it will be decreased _eventually_).
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100141 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200142#define BIGPOLL 9 /* 2^9 sec ~= 8.5 min */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100143#define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200144/*
145 * Actively lower poll when we see such big offsets.
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100146 * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200147 * if offset increases over ~0.04 sec
148 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200149//#define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100150#define MINDISP 0.01 /* minimum dispersion (sec) */
151#define MAXDISP 16 /* maximum dispersion (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100152#define MAXSTRAT 16 /* maximum stratum (infinity metric) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100153#define MAXDIST 1 /* distance threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100154#define MIN_SELECTED 1 /* minimum intersection survivors */
155#define MIN_CLUSTERED 3 /* minimum cluster survivors */
156
157#define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100158
159/* Poll-adjust threshold.
160 * When we see that offset is small enough compared to discipline jitter,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100161 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
Denys Vlasenko61313112010-01-01 19:56:16 +0100162 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100163 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
164 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100165 */
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100166#define POLLADJ_LIMIT 40
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100167/* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100168 * poll interval (we think we can't improve timekeeping
169 * by staying at smaller poll).
170 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100171#define POLLADJ_GATE 4
Denys Vlasenko132b0442012-03-05 00:51:48 +0100172#define TIMECONST_HACK_GATE 2
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100173/* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100174#define ALLAN 512
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100175/* PLL loop gain */
Denys Vlasenko61313112010-01-01 19:56:16 +0100176#define PLL 65536
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100177/* FLL loop gain [why it depends on MAXPOLL??] */
Denys Vlasenko61313112010-01-01 19:56:16 +0100178#define FLL (MAXPOLL + 1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100179/* Parameter averaging constant */
Denys Vlasenko61313112010-01-01 19:56:16 +0100180#define AVG 4
181
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100182
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100183enum {
184 NTP_VERSION = 4,
185 NTP_MAXSTRATUM = 15,
186
187 NTP_DIGESTSIZE = 16,
188 NTP_MSGSIZE_NOAUTH = 48,
189 NTP_MSGSIZE = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
190
191 /* Status Masks */
192 MODE_MASK = (7 << 0),
193 VERSION_MASK = (7 << 3),
194 VERSION_SHIFT = 3,
195 LI_MASK = (3 << 6),
196
197 /* Leap Second Codes (high order two bits of m_status) */
198 LI_NOWARNING = (0 << 6), /* no warning */
199 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
200 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
201 LI_ALARM = (3 << 6), /* alarm condition */
202
203 /* Mode values */
204 MODE_RES0 = 0, /* reserved */
205 MODE_SYM_ACT = 1, /* symmetric active */
206 MODE_SYM_PAS = 2, /* symmetric passive */
207 MODE_CLIENT = 3, /* client */
208 MODE_SERVER = 4, /* server */
209 MODE_BROADCAST = 5, /* broadcast */
210 MODE_RES1 = 6, /* reserved for NTP control message */
211 MODE_RES2 = 7, /* reserved for private use */
212};
213
214//TODO: better base selection
215#define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
216
217#define NUM_DATAPOINTS 8
218
219typedef struct {
220 uint32_t int_partl;
221 uint32_t fractionl;
222} l_fixedpt_t;
223
224typedef struct {
225 uint16_t int_parts;
226 uint16_t fractions;
227} s_fixedpt_t;
228
229typedef struct {
230 uint8_t m_status; /* status of local clock and leap info */
231 uint8_t m_stratum;
232 uint8_t m_ppoll; /* poll value */
233 int8_t m_precision_exp;
234 s_fixedpt_t m_rootdelay;
235 s_fixedpt_t m_rootdisp;
236 uint32_t m_refid;
237 l_fixedpt_t m_reftime;
238 l_fixedpt_t m_orgtime;
239 l_fixedpt_t m_rectime;
240 l_fixedpt_t m_xmttime;
241 uint32_t m_keyid;
242 uint8_t m_digest[NTP_DIGESTSIZE];
243} msg_t;
244
245typedef struct {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100246 double d_offset;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100247 double d_recv_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100248 double d_dispersion;
249} datapoint_t;
250
251typedef struct {
252 len_and_sockaddr *p_lsa;
253 char *p_dotted;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100254 int p_fd;
255 int datapoint_idx;
256 uint32_t lastpkt_refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100257 uint8_t lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100258 uint8_t lastpkt_stratum;
Denys Vlasenko0b002812010-01-03 08:59:59 +0100259 uint8_t reachable_bits;
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200260 /* when to send new query (if p_fd == -1)
261 * or when receive times out (if p_fd >= 0): */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100262 double next_action_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100263 double p_xmttime;
Denys Vlasenkod531f932014-04-19 19:00:16 +0200264 double p_raw_delay;
265 /* p_raw_delay is set even by "high delay" packets */
266 /* lastpkt_delay isn't */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100267 double lastpkt_recv_time;
268 double lastpkt_delay;
269 double lastpkt_rootdelay;
270 double lastpkt_rootdisp;
271 /* produced by filter algorithm: */
272 double filter_offset;
273 double filter_dispersion;
274 double filter_jitter;
275 datapoint_t filter_datapoint[NUM_DATAPOINTS];
276 /* last sent packet: */
277 msg_t p_xmt_msg;
278} peer_t;
279
280
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100281#define USING_KERNEL_PLL_LOOP 1
282#define USING_INITIAL_FREQ_ESTIMATION 0
283
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100284enum {
285 OPT_n = (1 << 0),
286 OPT_q = (1 << 1),
287 OPT_N = (1 << 2),
288 OPT_x = (1 << 3),
289 /* Insert new options above this line. */
290 /* Non-compat options: */
Denys Vlasenko4168fdd2010-01-04 00:19:13 +0100291 OPT_w = (1 << 4),
292 OPT_p = (1 << 5),
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100293 OPT_S = (1 << 6),
294 OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko278842d2014-07-15 15:06:54 +0200295 OPT_I = (1 << 8) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko8e23faf2011-04-07 01:45:20 +0200296 /* We hijack some bits for other purposes */
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100297 OPT_qq = (1 << 31),
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100298};
299
300struct globals {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100301 double cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100302 /* total round trip delay to currently selected reference clock */
303 double rootdelay;
304 /* reference timestamp: time when the system clock was last set or corrected */
305 double reftime;
306 /* total dispersion to currently selected reference clock */
307 double rootdisp;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100308
309 double last_script_run;
310 char *script_name;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100311 llist_t *ntp_peers;
312#if ENABLE_FEATURE_NTPD_SERVER
313 int listen_fd;
Denys Vlasenko278842d2014-07-15 15:06:54 +0200314 char *if_name;
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +0200315# define G_listen_fd (G.listen_fd)
316#else
317# define G_listen_fd (-1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100318#endif
319 unsigned verbose;
320 unsigned peer_cnt;
321 /* refid: 32-bit code identifying the particular server or reference clock
Denys Vlasenko74584b82012-03-02 01:22:40 +0100322 * in stratum 0 packets this is a four-character ASCII string,
323 * called the kiss code, used for debugging and monitoring
324 * in stratum 1 packets this is a four-character ASCII string
325 * assigned to the reference clock by IANA. Example: "GPS "
326 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
327 * of MD5 hash of IPv6
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100328 */
329 uint32_t refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100330 uint8_t ntp_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100331 /* precision is defined as the larger of the resolution and time to
332 * read the clock, in log2 units. For instance, the precision of a
333 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
334 * system clock hardware representation is to the nanosecond.
335 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100336 * Delays, jitters of various kinds are clamped down to precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100337 *
338 * If precision_sec is too large, discipline_jitter gets clamped to it
Denys Vlasenko74584b82012-03-02 01:22:40 +0100339 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
340 * interval grows even though we really can benefit from staying at
341 * smaller one, collecting non-lagged datapoits and correcting offset.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100342 * (Lagged datapoits exist when poll_exp is large but we still have
343 * systematic offset error - the time distance between datapoints
Denys Vlasenko74584b82012-03-02 01:22:40 +0100344 * is significant and older datapoints have smaller offsets.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100345 * This makes our offset estimation a bit smaller than reality)
346 * Due to this effect, setting G_precision_sec close to
347 * STEP_THRESHOLD isn't such a good idea - offsets may grow
348 * too big and we will step. I observed it with -6.
349 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100350 * OTOH, setting precision_sec far too small would result in futile
351 * attempts to syncronize to an unachievable precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100352 *
353 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
Denys Vlasenko74584b82012-03-02 01:22:40 +0100354 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
355 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100356 */
Denys Vlasenko74584b82012-03-02 01:22:40 +0100357#define G_precision_exp -9
358 /*
359 * G_precision_exp is used only for construction outgoing packets.
360 * It's ok to set G_precision_sec to a slightly different value
361 * (One which is "nicer looking" in logs).
362 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
363 */
364#define G_precision_sec 0.002
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100365 uint8_t stratum;
366 /* Bool. After set to 1, never goes back to 0: */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100367 smallint initial_poll_complete;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100368
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100369#define STATE_NSET 0 /* initial state, "nothing is set" */
370//#define STATE_FSET 1 /* frequency set from file */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +0100371//#define STATE_SPIK 2 /* spike detected */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100372//#define STATE_FREQ 3 /* initial frequency */
373#define STATE_SYNC 4 /* clock synchronized (normal operation) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100374 uint8_t discipline_state; // doc calls it c.state
375 uint8_t poll_exp; // s.poll
376 int polladj_count; // c.count
Denys Vlasenko61313112010-01-01 19:56:16 +0100377 long kernel_freq_drift;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100378 peer_t *last_update_peer;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100379 double last_update_offset; // c.last
Denys Vlasenko61313112010-01-01 19:56:16 +0100380 double last_update_recv_time; // s.t
381 double discipline_jitter; // c.jitter
Denys Vlasenko547ee792012-03-05 10:18:00 +0100382 /* Since we only compare it with ints, can simplify code
383 * by not making this variable floating point:
384 */
385 unsigned offset_to_jitter_ratio;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100386 //double cluster_offset; // s.offset
387 //double cluster_jitter; // s.jitter
Denys Vlasenko61313112010-01-01 19:56:16 +0100388#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100389 double discipline_freq_drift; // c.freq
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100390 /* Maybe conditionally calculate wander? it's used only for logging */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100391 double discipline_wander; // c.wander
Denys Vlasenko61313112010-01-01 19:56:16 +0100392#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100393};
394#define G (*ptr_to_globals)
395
396static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
397
398
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100399#define VERB1 if (MAX_VERBOSE && G.verbose)
400#define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
401#define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
402#define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
403#define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100404#define VERB6 if (MAX_VERBOSE >= 6 && G.verbose >= 6)
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100405
406
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100407static double LOG2D(int a)
408{
409 if (a < 0)
410 return 1.0 / (1UL << -a);
411 return 1UL << a;
412}
413static ALWAYS_INLINE double SQUARE(double x)
414{
415 return x * x;
416}
417static ALWAYS_INLINE double MAXD(double a, double b)
418{
419 if (a > b)
420 return a;
421 return b;
422}
423static ALWAYS_INLINE double MIND(double a, double b)
424{
425 if (a < b)
426 return a;
427 return b;
428}
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100429static NOINLINE double my_SQRT(double X)
430{
431 union {
432 float f;
433 int32_t i;
434 } v;
435 double invsqrt;
436 double Xhalf = X * 0.5;
437
438 /* Fast and good approximation to 1/sqrt(X), black magic */
439 v.f = X;
440 /*v.i = 0x5f3759df - (v.i >> 1);*/
441 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
442 invsqrt = v.f; /* better than 0.2% accuracy */
443
444 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
445 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
446 * f'(x) = -2/(x*x*x)
447 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
448 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
449 */
450 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
451 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
452 /* With 4 iterations, more than half results will be exact,
453 * at 6th iterations result stabilizes with about 72% results exact.
454 * We are well satisfied with 0.05% accuracy.
455 */
456
457 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
458}
459static ALWAYS_INLINE double SQRT(double X)
460{
461 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
462 if (sizeof(float) != 4)
463 return sqrt(X);
464
Denys Vlasenko2d3253d2010-01-03 21:52:46 +0100465 /* This avoids needing libm, saves about 0.5k on x86-32 */
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100466 return my_SQRT(X);
467}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100468
469static double
470gettime1900d(void)
471{
472 struct timeval tv;
473 gettimeofday(&tv, NULL); /* never fails */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100474 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
475 return G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100476}
477
478static void
479d_to_tv(double d, struct timeval *tv)
480{
481 tv->tv_sec = (long)d;
482 tv->tv_usec = (d - tv->tv_sec) * 1000000;
483}
484
485static double
486lfp_to_d(l_fixedpt_t lfp)
487{
488 double ret;
489 lfp.int_partl = ntohl(lfp.int_partl);
490 lfp.fractionl = ntohl(lfp.fractionl);
491 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
492 return ret;
493}
494static double
495sfp_to_d(s_fixedpt_t sfp)
496{
497 double ret;
498 sfp.int_parts = ntohs(sfp.int_parts);
499 sfp.fractions = ntohs(sfp.fractions);
500 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
501 return ret;
502}
503#if ENABLE_FEATURE_NTPD_SERVER
504static l_fixedpt_t
505d_to_lfp(double d)
506{
507 l_fixedpt_t lfp;
508 lfp.int_partl = (uint32_t)d;
509 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
510 lfp.int_partl = htonl(lfp.int_partl);
511 lfp.fractionl = htonl(lfp.fractionl);
512 return lfp;
513}
514static s_fixedpt_t
515d_to_sfp(double d)
516{
517 s_fixedpt_t sfp;
518 sfp.int_parts = (uint16_t)d;
519 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
520 sfp.int_parts = htons(sfp.int_parts);
521 sfp.fractions = htons(sfp.fractions);
522 return sfp;
523}
524#endif
525
526static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100527dispersion(const datapoint_t *dp)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100528{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100529 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100530}
531
532static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100533root_distance(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100534{
535 /* The root synchronization distance is the maximum error due to
536 * all causes of the local clock relative to the primary server.
537 * It is defined as half the total delay plus total dispersion
538 * plus peer jitter.
539 */
540 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
541 + p->lastpkt_rootdisp
542 + p->filter_dispersion
Denys Vlasenko0b002812010-01-03 08:59:59 +0100543 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100544 + p->filter_jitter;
545}
546
547static void
548set_next(peer_t *p, unsigned t)
549{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100550 p->next_action_time = G.cur_time + t;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100551}
552
553/*
554 * Peer clock filter and its helpers
555 */
556static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100557filter_datapoints(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100558{
559 int i, idx;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100560 double sum, wavg;
561 datapoint_t *fdp;
562
563#if 0
564/* Simulations have shown that use of *averaged* offset for p->filter_offset
565 * is in fact worse than simply using last received one: with large poll intervals
566 * (>= 2048) averaging code uses offset values which are outdated by hours,
567 * and time/frequency correction goes totally wrong when fed essentially bogus offsets.
568 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100569 int got_newest;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100570 double minoff, maxoff, w;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100571 double x = x; /* for compiler */
572 double oldest_off = oldest_off;
573 double oldest_age = oldest_age;
574 double newest_off = newest_off;
575 double newest_age = newest_age;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100576
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100577 fdp = p->filter_datapoint;
578
579 minoff = maxoff = fdp[0].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100580 for (i = 1; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100581 if (minoff > fdp[i].d_offset)
582 minoff = fdp[i].d_offset;
583 if (maxoff < fdp[i].d_offset)
584 maxoff = fdp[i].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100585 }
586
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100587 idx = p->datapoint_idx; /* most recent datapoint's index */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100588 /* Average offset:
589 * Drop two outliers and take weighted average of the rest:
590 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
591 * we use older6/32, not older6/64 since sum of weights should be 1:
592 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
593 */
594 wavg = 0;
595 w = 0.5;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100596 /* n-1
597 * --- dispersion(i)
598 * filter_dispersion = \ -------------
599 * / (i+1)
600 * --- 2
601 * i=0
602 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100603 got_newest = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100604 sum = 0;
605 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100606 VERB5 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100607 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
608 i,
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100609 fdp[idx].d_offset,
610 fdp[idx].d_dispersion, dispersion(&fdp[idx]),
611 G.cur_time - fdp[idx].d_recv_time,
612 (minoff == fdp[idx].d_offset || maxoff == fdp[idx].d_offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100613 ? " (outlier by offset)" : ""
614 );
615 }
616
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100617 sum += dispersion(&fdp[idx]) / (2 << i);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100618
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100619 if (minoff == fdp[idx].d_offset) {
Denys Vlasenkoe4844b82010-01-01 21:59:49 +0100620 minoff -= 1; /* so that we don't match it ever again */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100621 } else
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100622 if (maxoff == fdp[idx].d_offset) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100623 maxoff += 1;
624 } else {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100625 oldest_off = fdp[idx].d_offset;
626 oldest_age = G.cur_time - fdp[idx].d_recv_time;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100627 if (!got_newest) {
628 got_newest = 1;
629 newest_off = oldest_off;
630 newest_age = oldest_age;
631 }
632 x = oldest_off * w;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100633 wavg += x;
634 w /= 2;
635 }
636
637 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
638 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100639 p->filter_dispersion = sum;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100640 wavg += x; /* add another older6/64 to form older6/32 */
641 /* Fix systematic underestimation with large poll intervals.
642 * Imagine that we still have a bit of uncorrected drift,
643 * and poll interval is big (say, 100 sec). Offsets form a progression:
644 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
645 * The algorithm above drops 0.0 and 0.7 as outliers,
646 * and then we have this estimation, ~25% off from 0.7:
647 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
648 */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100649 x = oldest_age - newest_age;
650 if (x != 0) {
651 x = newest_age / x; /* in above example, 100 / (600 - 100) */
652 if (x < 1) { /* paranoia check */
653 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
654 wavg += x;
655 }
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100656 }
657 p->filter_offset = wavg;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100658
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100659#else
660
661 fdp = p->filter_datapoint;
662 idx = p->datapoint_idx; /* most recent datapoint's index */
663
664 /* filter_offset: simply use the most recent value */
665 p->filter_offset = fdp[idx].d_offset;
666
667 /* n-1
668 * --- dispersion(i)
669 * filter_dispersion = \ -------------
670 * / (i+1)
671 * --- 2
672 * i=0
673 */
674 wavg = 0;
675 sum = 0;
676 for (i = 0; i < NUM_DATAPOINTS; i++) {
677 sum += dispersion(&fdp[idx]) / (2 << i);
678 wavg += fdp[idx].d_offset;
679 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
680 }
681 wavg /= NUM_DATAPOINTS;
682 p->filter_dispersion = sum;
683#endif
684
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100685 /* +----- -----+ ^ 1/2
686 * | n-1 |
687 * | --- |
688 * | 1 \ 2 |
689 * filter_jitter = | --- * / (avg-offset_j) |
690 * | n --- |
691 * | j=0 |
692 * +----- -----+
693 * where n is the number of valid datapoints in the filter (n > 1);
694 * if filter_jitter < precision then filter_jitter = precision
695 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100696 sum = 0;
697 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100698 sum += SQUARE(wavg - fdp[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100699 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100700 sum = SQRT(sum / NUM_DATAPOINTS);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100701 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
702
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100703 VERB4 bb_error_msg("filter offset:%+f disp:%f jitter:%f",
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100704 p->filter_offset,
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100705 p->filter_dispersion,
706 p->filter_jitter);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100707}
708
709static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100710reset_peer_stats(peer_t *p, double offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100711{
712 int i;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100713 bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
714
Denys Vlasenko777be102013-12-07 17:29:03 +0100715 /* Used to set p->filter_datapoint[i].d_dispersion = MAXDISP
716 * and clear reachable bits, but this proved to be too agressive:
717 * after step (tested with suspinding laptop for ~30 secs),
718 * this caused all previous data to be considered invalid,
719 * making us needing to collect full ~8 datapoins per peer
720 * after step in order to start trusting them.
721 * In turn, this was making poll interval decrease even after
722 * step was done. (Poll interval decreases already before step
723 * in this scenario, because we see large offsets and end up with
724 * no good peer to select).
725 */
726
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100727 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100728 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200729 p->filter_datapoint[i].d_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100730 if (p->filter_datapoint[i].d_offset != 0) {
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100731 p->filter_datapoint[i].d_offset -= offset;
732 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
733 // i,
734 // p->filter_datapoint[i].d_offset + offset,
735 // p->filter_datapoint[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100736 }
737 } else {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100738 p->filter_datapoint[i].d_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100739 p->filter_datapoint[i].d_offset = 0;
Denys Vlasenko777be102013-12-07 17:29:03 +0100740 /*p->filter_datapoint[i].d_dispersion = MAXDISP;*/
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100741 }
742 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100743 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200744 p->lastpkt_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100745 } else {
Denys Vlasenko777be102013-12-07 17:29:03 +0100746 /*p->reachable_bits = 0;*/
Denys Vlasenko0b002812010-01-03 08:59:59 +0100747 p->lastpkt_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100748 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100749 filter_datapoints(p); /* recalc p->filter_xxx */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100750 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100751}
752
753static void
Denys Vlasenko504fe452014-03-23 15:06:38 +0100754add_peers(const char *s)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100755{
756 peer_t *p;
757
758 p = xzalloc(sizeof(*p));
759 p->p_lsa = xhost2sockaddr(s, 123);
760 p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
761 p->p_fd = -1;
762 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100763 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
764 reset_peer_stats(p, 16 * STEP_THRESHOLD);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100765
766 llist_add_to(&G.ntp_peers, p);
767 G.peer_cnt++;
768}
769
770static int
771do_sendto(int fd,
772 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
773 msg_t *msg, ssize_t len)
774{
775 ssize_t ret;
776
777 errno = 0;
778 if (!from) {
779 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
780 } else {
781 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
782 }
783 if (ret != len) {
784 bb_perror_msg("send failed");
785 return -1;
786 }
787 return 0;
788}
789
Denys Vlasenko0b002812010-01-03 08:59:59 +0100790static void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100791send_query_to_peer(peer_t *p)
792{
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100793 /* Why do we need to bind()?
794 * See what happens when we don't bind:
795 *
796 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
797 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
798 * gettimeofday({1259071266, 327885}, NULL) = 0
799 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
800 * ^^^ we sent it from some source port picked by kernel.
801 * time(NULL) = 1259071266
802 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
803 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
804 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
805 * ^^^ this recv will receive packets to any local port!
806 *
807 * Uncomment this and use strace to see it in action:
808 */
809#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 +0100810
811 if (p->p_fd == -1) {
812 int fd, family;
813 len_and_sockaddr *local_lsa;
814
815 family = p->p_lsa->u.sa.sa_family;
816 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
817 /* local_lsa has "null" address and port 0 now.
818 * bind() ensures we have a *particular port* selected by kernel
819 * and remembered in p->p_fd, thus later recv(p->p_fd)
820 * receives only packets sent to this port.
821 */
822 PROBE_LOCAL_ADDR
823 xbind(fd, &local_lsa->u.sa, local_lsa->len);
824 PROBE_LOCAL_ADDR
825#if ENABLE_FEATURE_IPV6
826 if (family == AF_INET)
827#endif
828 setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
829 free(local_lsa);
830 }
831
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100832 /* Emit message _before_ attempted send. Think of a very short
833 * roundtrip networks: we need to go back to recv loop ASAP,
834 * to reduce delay. Printing messages after send works against that.
835 */
836 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
837
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100838 /*
839 * Send out a random 64-bit number as our transmit time. The NTP
840 * server will copy said number into the originate field on the
841 * response that it sends us. This is totally legal per the SNTP spec.
842 *
843 * The impact of this is two fold: we no longer send out the current
844 * system time for the world to see (which may aid an attacker), and
845 * it gives us a (not very secure) way of knowing that we're not
846 * getting spoofed by an attacker that can't capture our traffic
847 * but can spoof packets from the NTP server we're communicating with.
848 *
849 * Save the real transmit timestamp locally.
850 */
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +0100851 p->p_xmt_msg.m_xmttime.int_partl = rand();
852 p->p_xmt_msg.m_xmttime.fractionl = rand();
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100853 p->p_xmttime = gettime1900d();
854
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200855 /* Were doing it only if sendto worked, but
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +0200856 * loss of sync detection needs reachable_bits updated
857 * even if sending fails *locally*:
858 * "network is unreachable" because cable was pulled?
859 * We still need to declare "unsync" if this condition persists.
860 */
861 p->reachable_bits <<= 1;
862
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100863 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
864 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
865 ) {
866 close(p->p_fd);
867 p->p_fd = -1;
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200868 /*
869 * We know that we sent nothing.
870 * We can retry *soon* without fearing
871 * that we are flooding the peer.
872 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100873 set_next(p, RETRY_INTERVAL);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100874 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100875 }
876
Denys Vlasenko0b002812010-01-03 08:59:59 +0100877 set_next(p, RESPONSE_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100878}
879
880
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100881/* Note that there is no provision to prevent several run_scripts
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200882 * to be started in quick succession. In fact, it happens rather often
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100883 * if initial syncronization results in a step.
884 * You will see "step" and then "stratum" script runs, sometimes
885 * as close as only 0.002 seconds apart.
886 * Script should be ready to deal with this.
887 */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100888static void run_script(const char *action, double offset)
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100889{
890 char *argv[3];
Denys Vlasenko12628b72010-01-11 01:31:59 +0100891 char *env1, *env2, *env3, *env4;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100892
Denys Vlasenko07c59872013-05-22 18:18:51 +0200893 G.last_script_run = G.cur_time;
894
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100895 if (!G.script_name)
896 return;
897
898 argv[0] = (char*) G.script_name;
899 argv[1] = (char*) action;
900 argv[2] = NULL;
901
902 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
903
Denys Vlasenkoae473352010-01-07 11:51:13 +0100904 env1 = xasprintf("%s=%u", "stratum", G.stratum);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100905 putenv(env1);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100906 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100907 putenv(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100908 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
909 putenv(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100910 env4 = xasprintf("%s=%f", "offset", offset);
911 putenv(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100912 /* Other items of potential interest: selected peer,
Denys Vlasenkoae473352010-01-07 11:51:13 +0100913 * rootdelay, reftime, rootdisp, refid, ntp_status,
Denys Vlasenko12628b72010-01-11 01:31:59 +0100914 * last_update_offset, last_update_recv_time, discipline_jitter,
915 * how many peers have reachable_bits = 0?
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100916 */
917
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100918 /* Don't want to wait: it may run hwclock --systohc, and that
919 * may take some time (seconds): */
Denys Vlasenko8531d762010-03-18 22:44:00 +0100920 /*spawn_and_wait(argv);*/
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100921 spawn(argv);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100922
923 unsetenv("stratum");
924 unsetenv("freq_drift_ppm");
Denys Vlasenkoae473352010-01-07 11:51:13 +0100925 unsetenv("poll_interval");
Denys Vlasenko12628b72010-01-11 01:31:59 +0100926 unsetenv("offset");
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100927 free(env1);
928 free(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100929 free(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100930 free(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100931}
932
Denys Vlasenko0b002812010-01-03 08:59:59 +0100933static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100934step_time(double offset)
935{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100936 llist_t *item;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100937 double dtime;
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100938 struct timeval tvc, tvn;
939 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100940 time_t tval;
941
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100942 gettimeofday(&tvc, NULL); /* never fails */
943 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
944 d_to_tv(dtime, &tvn);
945 if (settimeofday(&tvn, NULL) == -1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100946 bb_perror_msg_and_die("settimeofday");
947
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100948 VERB2 {
949 tval = tvc.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100950 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100951 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
952 }
953 tval = tvn.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100954 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100955 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100956
957 /* Correct various fields which contain time-relative values: */
958
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200959 /* Globals: */
960 G.cur_time += offset;
961 G.last_update_recv_time += offset;
962 G.last_script_run += offset;
963
Denys Vlasenko0b002812010-01-03 08:59:59 +0100964 /* p->lastpkt_recv_time, p->next_action_time and such: */
965 for (item = G.ntp_peers; item != NULL; item = item->link) {
966 peer_t *pp = (peer_t *) item->data;
967 reset_peer_stats(pp, offset);
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100968 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200969 // offset, pp->next_action_time, pp->next_action_time + offset);
970 pp->next_action_time += offset;
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200971 if (pp->p_fd >= 0) {
972 /* We wait for reply from this peer too.
973 * But due to step we are doing, reply's data is no longer
974 * useful (in fact, it'll be bogus). Stop waiting for it.
975 */
976 close(pp->p_fd);
977 pp->p_fd = -1;
978 set_next(pp, RETRY_INTERVAL);
979 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100980 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100981}
982
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200983static void clamp_pollexp_and_set_MAXSTRAT(void)
984{
985 if (G.poll_exp < MINPOLL)
986 G.poll_exp = MINPOLL;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200987 if (G.poll_exp > BIGPOLL)
988 G.poll_exp = BIGPOLL;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200989 G.polladj_count = 0;
990 G.stratum = MAXSTRAT;
991}
992
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100993
994/*
995 * Selection and clustering, and their helpers
996 */
997typedef struct {
998 peer_t *p;
999 int type;
1000 double edge;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001001 double opt_rd; /* optimization */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001002} point_t;
1003static int
1004compare_point_edge(const void *aa, const void *bb)
1005{
1006 const point_t *a = aa;
1007 const point_t *b = bb;
1008 if (a->edge < b->edge) {
1009 return -1;
1010 }
1011 return (a->edge > b->edge);
1012}
1013typedef struct {
1014 peer_t *p;
1015 double metric;
1016} survivor_t;
1017static int
1018compare_survivor_metric(const void *aa, const void *bb)
1019{
1020 const survivor_t *a = aa;
1021 const survivor_t *b = bb;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001022 if (a->metric < b->metric) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001023 return -1;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001024 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001025 return (a->metric > b->metric);
1026}
1027static int
1028fit(peer_t *p, double rd)
1029{
Denys Vlasenko0b002812010-01-03 08:59:59 +01001030 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
1031 /* One or zero bits in reachable_bits */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001032 VERB4 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001033 return 0;
1034 }
Denys Vlasenkofb132e42010-10-29 11:46:52 +02001035#if 0 /* we filter out such packets earlier */
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001036 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001037 || p->lastpkt_stratum >= MAXSTRAT
1038 ) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001039 VERB4 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001040 return 0;
1041 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001042#endif
Denys Vlasenko0b002812010-01-03 08:59:59 +01001043 /* rd is root_distance(p) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001044 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001045 VERB4 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001046 return 0;
1047 }
1048//TODO
1049// /* Do we have a loop? */
1050// if (p->refid == p->dstaddr || p->refid == s.refid)
1051// return 0;
Denys Vlasenkob7c9fb22011-02-03 00:05:48 +01001052 return 1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001053}
1054static peer_t*
Denys Vlasenko0b002812010-01-03 08:59:59 +01001055select_and_cluster(void)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001056{
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001057 peer_t *p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001058 llist_t *item;
1059 int i, j;
1060 int size = 3 * G.peer_cnt;
1061 /* for selection algorithm */
1062 point_t point[size];
1063 unsigned num_points, num_candidates;
1064 double low, high;
1065 unsigned num_falsetickers;
1066 /* for cluster algorithm */
1067 survivor_t survivor[size];
1068 unsigned num_survivors;
1069
1070 /* Selection */
1071
1072 num_points = 0;
1073 item = G.ntp_peers;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001074 if (G.initial_poll_complete) while (item != NULL) {
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001075 double rd, offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001076
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001077 p = (peer_t *) item->data;
1078 rd = root_distance(p);
1079 offset = p->filter_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001080 if (!fit(p, rd)) {
1081 item = item->link;
1082 continue;
1083 }
1084
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001085 VERB5 bb_error_msg("interval: [%f %f %f] %s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001086 offset - rd,
1087 offset,
1088 offset + rd,
1089 p->p_dotted
1090 );
1091 point[num_points].p = p;
1092 point[num_points].type = -1;
1093 point[num_points].edge = offset - rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001094 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001095 num_points++;
1096 point[num_points].p = p;
1097 point[num_points].type = 0;
1098 point[num_points].edge = offset;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001099 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001100 num_points++;
1101 point[num_points].p = p;
1102 point[num_points].type = 1;
1103 point[num_points].edge = offset + rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001104 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001105 num_points++;
1106 item = item->link;
1107 }
1108 num_candidates = num_points / 3;
1109 if (num_candidates == 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001110 VERB3 bb_error_msg("no valid datapoints%s", ", no peer selected");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001111 return NULL;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001112 }
1113//TODO: sorting does not seem to be done in reference code
1114 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
1115
1116 /* Start with the assumption that there are no falsetickers.
1117 * Attempt to find a nonempty intersection interval containing
1118 * the midpoints of all truechimers.
1119 * If a nonempty interval cannot be found, increase the number
1120 * of assumed falsetickers by one and try again.
1121 * If a nonempty interval is found and the number of falsetickers
1122 * is less than the number of truechimers, a majority has been found
1123 * and the midpoint of each truechimer represents
1124 * the candidates available to the cluster algorithm.
1125 */
1126 num_falsetickers = 0;
1127 while (1) {
1128 int c;
1129 unsigned num_midpoints = 0;
1130
1131 low = 1 << 9;
1132 high = - (1 << 9);
1133 c = 0;
1134 for (i = 0; i < num_points; i++) {
1135 /* We want to do:
1136 * if (point[i].type == -1) c++;
1137 * if (point[i].type == 1) c--;
1138 * and it's simpler to do it this way:
1139 */
1140 c -= point[i].type;
1141 if (c >= num_candidates - num_falsetickers) {
1142 /* If it was c++ and it got big enough... */
1143 low = point[i].edge;
1144 break;
1145 }
1146 if (point[i].type == 0)
1147 num_midpoints++;
1148 }
1149 c = 0;
1150 for (i = num_points-1; i >= 0; i--) {
1151 c += point[i].type;
1152 if (c >= num_candidates - num_falsetickers) {
1153 high = point[i].edge;
1154 break;
1155 }
1156 if (point[i].type == 0)
1157 num_midpoints++;
1158 }
1159 /* If the number of midpoints is greater than the number
1160 * of allowed falsetickers, the intersection contains at
1161 * least one truechimer with no midpoint - bad.
1162 * Also, interval should be nonempty.
1163 */
1164 if (num_midpoints <= num_falsetickers && low < high)
1165 break;
1166 num_falsetickers++;
1167 if (num_falsetickers * 2 >= num_candidates) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001168 VERB3 bb_error_msg("falsetickers:%d, candidates:%d%s",
1169 num_falsetickers, num_candidates,
1170 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001171 return NULL;
1172 }
1173 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001174 VERB4 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001175 low, high, num_candidates, num_falsetickers);
1176
1177 /* Clustering */
1178
1179 /* Construct a list of survivors (p, metric)
1180 * from the chime list, where metric is dominated
1181 * first by stratum and then by root distance.
1182 * All other things being equal, this is the order of preference.
1183 */
1184 num_survivors = 0;
1185 for (i = 0; i < num_points; i++) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001186 if (point[i].edge < low || point[i].edge > high)
1187 continue;
1188 p = point[i].p;
1189 survivor[num_survivors].p = p;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001190 /* x.opt_rd == root_distance(p); */
1191 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001192 VERB5 bb_error_msg("survivor[%d] metric:%f peer:%s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001193 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1194 num_survivors++;
1195 }
1196 /* There must be at least MIN_SELECTED survivors to satisfy the
1197 * correctness assertions. Ordinarily, the Byzantine criteria
1198 * require four survivors, but for the demonstration here, one
1199 * is acceptable.
1200 */
1201 if (num_survivors < MIN_SELECTED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001202 VERB3 bb_error_msg("survivors:%d%s",
1203 num_survivors,
1204 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001205 return NULL;
1206 }
1207
1208//looks like this is ONLY used by the fact that later we pick survivor[0].
1209//we can avoid sorting then, just find the minimum once!
1210 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1211
1212 /* For each association p in turn, calculate the selection
1213 * jitter p->sjitter as the square root of the sum of squares
1214 * (p->offset - q->offset) over all q associations. The idea is
1215 * to repeatedly discard the survivor with maximum selection
1216 * jitter until a termination condition is met.
1217 */
1218 while (1) {
1219 unsigned max_idx = max_idx;
1220 double max_selection_jitter = max_selection_jitter;
1221 double min_jitter = min_jitter;
1222
1223 if (num_survivors <= MIN_CLUSTERED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001224 VERB4 bb_error_msg("num_survivors %d <= %d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001225 num_survivors, MIN_CLUSTERED);
1226 break;
1227 }
1228
1229 /* To make sure a few survivors are left
1230 * for the clustering algorithm to chew on,
1231 * we stop if the number of survivors
1232 * is less than or equal to MIN_CLUSTERED (3).
1233 */
1234 for (i = 0; i < num_survivors; i++) {
1235 double selection_jitter_sq;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001236
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001237 p = survivor[i].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001238 if (i == 0 || p->filter_jitter < min_jitter)
1239 min_jitter = p->filter_jitter;
1240
1241 selection_jitter_sq = 0;
1242 for (j = 0; j < num_survivors; j++) {
1243 peer_t *q = survivor[j].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001244 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1245 }
1246 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1247 max_selection_jitter = selection_jitter_sq;
1248 max_idx = i;
1249 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001250 VERB6 bb_error_msg("survivor %d selection_jitter^2:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001251 i, selection_jitter_sq);
1252 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001253 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001254 VERB5 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001255 max_idx, max_selection_jitter, min_jitter);
1256
1257 /* If the maximum selection jitter is less than the
1258 * minimum peer jitter, then tossing out more survivors
1259 * will not lower the minimum peer jitter, so we might
1260 * as well stop.
1261 */
1262 if (max_selection_jitter < min_jitter) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001263 VERB4 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001264 max_selection_jitter, min_jitter, num_survivors);
1265 break;
1266 }
1267
1268 /* Delete survivor[max_idx] from the list
1269 * and go around again.
1270 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001271 VERB6 bb_error_msg("dropping survivor %d", max_idx);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001272 num_survivors--;
1273 while (max_idx < num_survivors) {
1274 survivor[max_idx] = survivor[max_idx + 1];
1275 max_idx++;
1276 }
1277 }
1278
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001279 if (0) {
1280 /* Combine the offsets of the clustering algorithm survivors
1281 * using a weighted average with weight determined by the root
1282 * distance. Compute the selection jitter as the weighted RMS
1283 * difference between the first survivor and the remaining
1284 * survivors. In some cases the inherent clock jitter can be
1285 * reduced by not using this algorithm, especially when frequent
1286 * clockhopping is involved. bbox: thus we don't do it.
1287 */
1288 double x, y, z, w;
1289 y = z = w = 0;
1290 for (i = 0; i < num_survivors; i++) {
1291 p = survivor[i].p;
1292 x = root_distance(p);
1293 y += 1 / x;
1294 z += p->filter_offset / x;
1295 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1296 }
1297 //G.cluster_offset = z / y;
1298 //G.cluster_jitter = SQRT(w / y);
1299 }
1300
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001301 /* Pick the best clock. If the old system peer is on the list
1302 * and at the same stratum as the first survivor on the list,
1303 * then don't do a clock hop. Otherwise, select the first
1304 * survivor on the list as the new system peer.
1305 */
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001306 p = survivor[0].p;
1307 if (G.last_update_peer
1308 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1309 ) {
1310 /* Starting from 1 is ok here */
1311 for (i = 1; i < num_survivors; i++) {
1312 if (G.last_update_peer == survivor[i].p) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001313 VERB5 bb_error_msg("keeping old synced peer");
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001314 p = G.last_update_peer;
1315 goto keep_old;
1316 }
1317 }
1318 }
1319 G.last_update_peer = p;
1320 keep_old:
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001321 VERB4 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001322 p->p_dotted,
1323 p->filter_offset,
1324 G.cur_time - p->lastpkt_recv_time
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001325 );
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001326 return p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001327}
1328
1329
1330/*
1331 * Local clock discipline and its helpers
1332 */
1333static void
1334set_new_values(int disc_state, double offset, double recv_time)
1335{
1336 /* Enter new state and set state variables. Note we use the time
1337 * of the last clock filter sample, which must be earlier than
1338 * the current time.
1339 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001340 VERB4 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001341 disc_state, offset, recv_time);
1342 G.discipline_state = disc_state;
1343 G.last_update_offset = offset;
1344 G.last_update_recv_time = recv_time;
1345}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001346/* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001347static NOINLINE int
1348update_local_clock(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001349{
1350 int rc;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001351 struct timex tmx;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001352 /* Note: can use G.cluster_offset instead: */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001353 double offset = p->filter_offset;
1354 double recv_time = p->lastpkt_recv_time;
1355 double abs_offset;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001356#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001357 double freq_drift;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001358#endif
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001359#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001360 double since_last_update;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001361#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001362 double etemp, dtemp;
1363
1364 abs_offset = fabs(offset);
1365
Denys Vlasenko12628b72010-01-11 01:31:59 +01001366#if 0
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001367 /* If needed, -S script can do it by looking at $offset
1368 * env var and killing parent */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001369 /* If the offset is too large, give up and go home */
1370 if (abs_offset > PANIC_THRESHOLD) {
1371 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1372 }
Denys Vlasenko12628b72010-01-11 01:31:59 +01001373#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001374
1375 /* If this is an old update, for instance as the result
1376 * of a system peer change, avoid it. We never use
1377 * an old sample or the same sample twice.
1378 */
1379 if (recv_time <= G.last_update_recv_time) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001380 VERB3 bb_error_msg("update from %s: same or older datapoint, not using it",
1381 p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001382 return 0; /* "leave poll interval as is" */
1383 }
1384
1385 /* Clock state machine transition function. This is where the
1386 * action is and defines how the system reacts to large time
1387 * and frequency errors.
1388 */
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001389#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001390 since_last_update = recv_time - G.reftime;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001391#endif
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001392#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001393 freq_drift = 0;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001394#endif
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001395#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001396 if (G.discipline_state == STATE_FREQ) {
1397 /* Ignore updates until the stepout threshold */
1398 if (since_last_update < WATCH_THRESHOLD) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001399 VERB4 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001400 WATCH_THRESHOLD - since_last_update);
1401 return 0; /* "leave poll interval as is" */
1402 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001403# if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001404 freq_drift = (offset - G.last_update_offset) / since_last_update;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001405# endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001406 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001407#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001408
1409 /* There are two main regimes: when the
1410 * offset exceeds the step threshold and when it does not.
1411 */
1412 if (abs_offset > STEP_THRESHOLD) {
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001413#if 0
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001414 double remains;
1415
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001416// This "spike state" seems to be useless, peer selection already drops
1417// occassional "bad" datapoints. If we are here, there were _many_
1418// large offsets. When a few first large offsets are seen,
1419// we end up in "no valid datapoints, no peer selected" state.
1420// Only when enough of them are seen (which means it's not a fluke),
1421// we end up here. Looks like _our_ clock is off.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001422 switch (G.discipline_state) {
1423 case STATE_SYNC:
1424 /* The first outlyer: ignore it, switch to SPIK state */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001425 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1426 p->p_dotted, offset,
1427 "");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001428 G.discipline_state = STATE_SPIK;
1429 return -1; /* "decrease poll interval" */
1430
1431 case STATE_SPIK:
1432 /* Ignore succeeding outlyers until either an inlyer
1433 * is found or the stepout threshold is exceeded.
1434 */
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001435 remains = WATCH_THRESHOLD - since_last_update;
1436 if (remains > 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001437 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1438 p->p_dotted, offset,
1439 ", datapoint ignored");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001440 return -1; /* "decrease poll interval" */
1441 }
1442 /* fall through: we need to step */
1443 } /* switch */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001444#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001445
1446 /* Step the time and clamp down the poll interval.
1447 *
1448 * In NSET state an initial frequency correction is
1449 * not available, usually because the frequency file has
1450 * not yet been written. Since the time is outside the
1451 * capture range, the clock is stepped. The frequency
1452 * will be set directly following the stepout interval.
1453 *
1454 * In FSET state the initial frequency has been set
1455 * from the frequency file. Since the time is outside
1456 * the capture range, the clock is stepped immediately,
1457 * rather than after the stepout interval. Guys get
1458 * nervous if it takes 17 minutes to set the clock for
1459 * the first time.
1460 *
1461 * In SPIK state the stepout threshold has expired and
1462 * the phase is still above the step threshold. Note
1463 * that a single spike greater than the step threshold
1464 * is always suppressed, even at the longer poll
1465 * intervals.
1466 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001467 VERB4 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001468 step_time(offset);
1469 if (option_mask32 & OPT_q) {
1470 /* We were only asked to set time once. Done. */
1471 exit(0);
1472 }
1473
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001474 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001475
Denys Vlasenko12628b72010-01-11 01:31:59 +01001476 run_script("step", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001477
Denys Vlasenkocb761132014-01-08 17:17:52 +01001478 recv_time += offset;
1479
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001480#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001481 if (G.discipline_state == STATE_NSET) {
1482 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1483 return 1; /* "ok to increase poll interval" */
1484 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001485#endif
Denys Vlasenko547ee792012-03-05 10:18:00 +01001486 abs_offset = offset = 0;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001487 set_new_values(STATE_SYNC, offset, recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001488
1489 } else { /* abs_offset <= STEP_THRESHOLD */
1490
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001491 /* The ratio is calculated before jitter is updated to make
1492 * poll adjust code more sensitive to large offsets.
1493 */
1494 G.offset_to_jitter_ratio = abs_offset / G.discipline_jitter;
1495
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001496 /* Compute the clock jitter as the RMS of exponentially
1497 * weighted offset differences. Used by the poll adjust code.
1498 */
1499 etemp = SQUARE(G.discipline_jitter);
Denys Vlasenko74584b82012-03-02 01:22:40 +01001500 dtemp = SQUARE(offset - G.last_update_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001501 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001502 if (G.discipline_jitter < G_precision_sec)
1503 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001504
1505 switch (G.discipline_state) {
1506 case STATE_NSET:
1507 if (option_mask32 & OPT_q) {
1508 /* We were only asked to set time once.
1509 * The clock is precise enough, no need to step.
1510 */
1511 exit(0);
1512 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001513#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001514 /* This is the first update received and the frequency
1515 * has not been initialized. The first thing to do
1516 * is directly measure the oscillator frequency.
1517 */
1518 set_new_values(STATE_FREQ, offset, recv_time);
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001519#else
1520 set_new_values(STATE_SYNC, offset, recv_time);
1521#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001522 VERB4 bb_error_msg("transitioning to FREQ, datapoint ignored");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001523 return 0; /* "leave poll interval as is" */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001524
1525#if 0 /* this is dead code for now */
1526 case STATE_FSET:
1527 /* This is the first update and the frequency
1528 * has been initialized. Adjust the phase, but
1529 * don't adjust the frequency until the next update.
1530 */
1531 set_new_values(STATE_SYNC, offset, recv_time);
1532 /* freq_drift remains 0 */
1533 break;
1534#endif
1535
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001536#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001537 case STATE_FREQ:
1538 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1539 * Correct the phase and frequency and switch to SYNC state.
1540 * freq_drift was already estimated (see code above)
1541 */
1542 set_new_values(STATE_SYNC, offset, recv_time);
1543 break;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001544#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001545
1546 default:
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001547#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001548 /* Compute freq_drift due to PLL and FLL contributions.
1549 *
1550 * The FLL and PLL frequency gain constants
1551 * depend on the poll interval and Allan
1552 * intercept. The FLL is not used below one-half
1553 * the Allan intercept. Above that the loop gain
1554 * increases in steps to 1 / AVG.
1555 */
1556 if ((1 << G.poll_exp) > ALLAN / 2) {
1557 etemp = FLL - G.poll_exp;
1558 if (etemp < AVG)
1559 etemp = AVG;
1560 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1561 }
1562 /* For the PLL the integration interval
1563 * (numerator) is the minimum of the update
1564 * interval and poll interval. This allows
1565 * oversampling, but not undersampling.
1566 */
1567 etemp = MIND(since_last_update, (1 << G.poll_exp));
1568 dtemp = (4 * PLL) << G.poll_exp;
1569 freq_drift += offset * etemp / SQUARE(dtemp);
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001570#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001571 set_new_values(STATE_SYNC, offset, recv_time);
1572 break;
1573 }
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001574 if (G.stratum != p->lastpkt_stratum + 1) {
1575 G.stratum = p->lastpkt_stratum + 1;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001576 run_script("stratum", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001577 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001578 }
1579
Denys Vlasenko0b002812010-01-03 08:59:59 +01001580 G.reftime = G.cur_time;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001581 G.ntp_status = p->lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001582 G.refid = p->lastpkt_refid;
1583 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001584 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
Denys Vlasenko0b002812010-01-03 08:59:59 +01001585 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001586 G.rootdisp = p->lastpkt_rootdisp + dtemp;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001587 VERB4 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001588
1589 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1590 * (Any other state does not reach this, they all return earlier)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001591 * By this time, freq_drift and offset are set
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001592 * to values suitable for adjtimex.
Denys Vlasenko61313112010-01-01 19:56:16 +01001593 */
1594#if !USING_KERNEL_PLL_LOOP
1595 /* Calculate the new frequency drift and frequency stability (wander).
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001596 * Compute the clock wander as the RMS of exponentially weighted
1597 * frequency differences. This is not used directly, but can,
1598 * along with the jitter, be a highly useful monitoring and
1599 * debugging tool.
1600 */
1601 dtemp = G.discipline_freq_drift + freq_drift;
Denys Vlasenko61313112010-01-01 19:56:16 +01001602 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001603 etemp = SQUARE(G.discipline_wander);
1604 dtemp = SQUARE(dtemp);
1605 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1606
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001607 VERB4 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
Denys Vlasenko61313112010-01-01 19:56:16 +01001608 G.discipline_freq_drift,
1609 (long)(G.discipline_freq_drift * 65536e6),
1610 freq_drift,
1611 G.discipline_wander);
1612#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001613 VERB4 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001614 memset(&tmx, 0, sizeof(tmx));
1615 if (adjtimex(&tmx) < 0)
1616 bb_perror_msg_and_die("adjtimex");
Denys Vlasenko8be49c32012-03-06 19:16:50 +01001617 bb_error_msg("p adjtimex freq:%ld offset:%+ld status:0x%x tc:%ld",
1618 tmx.freq, tmx.offset, tmx.status, tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001619 }
1620
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001621 memset(&tmx, 0, sizeof(tmx));
1622#if 0
Denys Vlasenko61313112010-01-01 19:56:16 +01001623//doesn't work, offset remains 0 (!) in kernel:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001624//ntpd: set adjtimex freq:1786097 tmx.offset:77487
1625//ntpd: prev adjtimex freq:1786097 tmx.offset:0
1626//ntpd: cur adjtimex freq:1786097 tmx.offset:0
1627 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1628 /* 65536 is one ppm */
1629 tmx.freq = G.discipline_freq_drift * 65536e6;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001630#endif
1631 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001632 tmx.offset = (offset * 1000000); /* usec */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001633 tmx.status = STA_PLL;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001634 if (G.ntp_status & LI_PLUSSEC)
1635 tmx.status |= STA_INS;
1636 if (G.ntp_status & LI_MINUSSEC)
1637 tmx.status |= STA_DEL;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001638
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001639 tmx.constant = G.poll_exp - 4;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001640 /* EXPERIMENTAL.
1641 * The below if statement should be unnecessary, but...
1642 * It looks like Linux kernel's PLL is far too gentle in changing
1643 * tmx.freq in response to clock offset. Offset keeps growing
1644 * and eventually we fall back to smaller poll intervals.
1645 * We can make correction more agressive (about x2) by supplying
1646 * PLL time constant which is one less than the real one.
1647 * To be on a safe side, let's do it only if offset is significantly
1648 * larger than jitter.
1649 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001650 if (tmx.constant > 0 && G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001651 tmx.constant--;
1652
1653 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1654 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001655 rc = adjtimex(&tmx);
1656 if (rc < 0)
1657 bb_perror_msg_and_die("adjtimex");
Denys Vlasenkod9109e32010-01-02 00:36:43 +01001658 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1659 * Not sure why. Perhaps it is normal.
1660 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001661 VERB4 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001662 rc, tmx.freq, tmx.offset, tmx.status);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001663 G.kernel_freq_drift = tmx.freq / 65536;
Denys Vlasenko547ee792012-03-05 10:18:00 +01001664 VERB2 bb_error_msg("update from:%s offset:%+f jitter:%f clock drift:%+.3fppm tc:%d",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001665 p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001666
1667 return 1; /* "ok to increase poll interval" */
1668}
1669
1670
1671/*
1672 * We've got a new reply packet from a peer, process it
1673 * (helpers first)
1674 */
1675static unsigned
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001676poll_interval(int upper_bound)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001677{
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001678 unsigned interval, r, mask;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001679 interval = 1 << G.poll_exp;
1680 if (interval > upper_bound)
1681 interval = upper_bound;
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001682 mask = ((interval-1) >> 4) | 1;
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01001683 r = rand();
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001684 interval += r & mask; /* ~ random(0..1) * interval/16 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001685 VERB4 bb_error_msg("chose poll interval:%u (poll_exp:%d)", interval, G.poll_exp);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001686 return interval;
1687}
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001688static void
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001689adjust_poll(int count)
1690{
1691 G.polladj_count += count;
1692 if (G.polladj_count > POLLADJ_LIMIT) {
1693 G.polladj_count = 0;
1694 if (G.poll_exp < MAXPOLL) {
1695 G.poll_exp++;
1696 VERB4 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1697 G.discipline_jitter, G.poll_exp);
1698 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001699 } else if (G.polladj_count < -POLLADJ_LIMIT || (count < 0 && G.poll_exp > BIGPOLL)) {
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001700 G.polladj_count = 0;
1701 if (G.poll_exp > MINPOLL) {
1702 llist_t *item;
1703
1704 G.poll_exp--;
1705 /* Correct p->next_action_time in each peer
1706 * which waits for sending, so that they send earlier.
1707 * Old pp->next_action_time are on the order
1708 * of t + (1 << old_poll_exp) + small_random,
1709 * we simply need to subtract ~half of that.
1710 */
1711 for (item = G.ntp_peers; item != NULL; item = item->link) {
1712 peer_t *pp = (peer_t *) item->data;
1713 if (pp->p_fd < 0)
1714 pp->next_action_time -= (1 << G.poll_exp);
1715 }
1716 VERB4 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1717 G.discipline_jitter, G.poll_exp);
1718 }
1719 } else {
1720 VERB4 bb_error_msg("polladj: count:%d", G.polladj_count);
1721 }
1722}
1723static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001724recv_and_process_peer_pkt(peer_t *p)
1725{
1726 int rc;
1727 ssize_t size;
1728 msg_t msg;
1729 double T1, T2, T3, T4;
Denys Vlasenkod531f932014-04-19 19:00:16 +02001730 double offset;
1731 double prev_delay, delay;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001732 unsigned interval;
1733 datapoint_t *datapoint;
1734 peer_t *q;
1735
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001736 offset = 0;
1737
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001738 /* We can recvfrom here and check from.IP, but some multihomed
1739 * ntp servers reply from their *other IP*.
1740 * TODO: maybe we should check at least what we can: from.port == 123?
1741 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001742 recv_again:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001743 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001744 if (size < 0) {
1745 if (errno == EINTR)
1746 /* Signal caught */
1747 goto recv_again;
1748 if (errno == EAGAIN)
1749 /* There was no packet after all
1750 * (poll() returning POLLIN for a fd
1751 * is not a ironclad guarantee that data is there)
1752 */
1753 return;
1754 /*
1755 * If you need a different handling for a specific
1756 * errno, always explain it in comment.
1757 */
1758 bb_perror_msg_and_die("recv(%s) error", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001759 }
1760
1761 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1762 bb_error_msg("malformed packet received from %s", p->p_dotted);
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001763 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001764 }
1765
1766 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1767 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1768 ) {
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001769 /* Somebody else's packet */
1770 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001771 }
1772
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001773 /* We do not expect any more packets from this peer for now.
1774 * Closing the socket informs kernel about it.
1775 * We open a new socket when we send a new query.
1776 */
1777 close(p->p_fd);
1778 p->p_fd = -1;
1779
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001780 if ((msg.m_status & LI_ALARM) == LI_ALARM
1781 || msg.m_stratum == 0
1782 || msg.m_stratum > NTP_MAXSTRATUM
1783 ) {
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001784 bb_error_msg("reply from %s: peer is unsynced", p->p_dotted);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001785 /*
1786 * Stratum 0 responses may have commands in 32-bit m_refid field:
1787 * "DENY", "RSTR" - peer does not like us at all,
1788 * "RATE" - peer is overloaded, reduce polling freq.
1789 * If poll interval is small, increase it.
1790 */
1791 if (G.poll_exp < BIGPOLL)
1792 goto increase_interval;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001793 goto pick_normal_interval;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001794 }
1795
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001796// /* Verify valid root distance */
1797// if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1798// return; /* invalid header values */
1799
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001800 /*
1801 * From RFC 2030 (with a correction to the delay math):
1802 *
1803 * Timestamp Name ID When Generated
1804 * ------------------------------------------------------------
1805 * Originate Timestamp T1 time request sent by client
1806 * Receive Timestamp T2 time request received by server
1807 * Transmit Timestamp T3 time reply sent by server
1808 * Destination Timestamp T4 time reply received by client
1809 *
1810 * The roundtrip delay and local clock offset are defined as
1811 *
1812 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1813 */
1814 T1 = p->p_xmttime;
1815 T2 = lfp_to_d(msg.m_rectime);
1816 T3 = lfp_to_d(msg.m_xmttime);
Denys Vlasenko0b002812010-01-03 08:59:59 +01001817 T4 = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001818
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001819 /* The delay calculation is a special case. In cases where the
1820 * server and client clocks are running at different rates and
1821 * with very fast networks, the delay can appear negative. In
1822 * order to avoid violating the Principle of Least Astonishment,
1823 * the delay is clamped not less than the system precision.
1824 */
Denys Vlasenkod531f932014-04-19 19:00:16 +02001825 delay = (T4 - T1) - (T3 - T2);
1826 if (delay < G_precision_sec)
1827 delay = G_precision_sec;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001828 /*
1829 * If this packet's delay is much bigger than the last one,
1830 * it's better to just ignore it than use its much less precise value.
1831 */
Denys Vlasenkod531f932014-04-19 19:00:16 +02001832 prev_delay = p->p_raw_delay;
1833 p->p_raw_delay = delay;
1834 if (p->reachable_bits && delay > prev_delay * BAD_DELAY_GROWTH) {
Denys Vlasenko5a21c852014-04-20 13:04:23 +02001835 bb_error_msg("reply from %s: delay %f is too high, ignoring", p->p_dotted, delay);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001836 goto pick_normal_interval;
1837 }
1838
Denys Vlasenkod531f932014-04-19 19:00:16 +02001839 p->lastpkt_delay = delay;
1840 p->lastpkt_recv_time = T4;
1841 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1842 p->lastpkt_status = msg.m_status;
1843 p->lastpkt_stratum = msg.m_stratum;
1844 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1845 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1846 p->lastpkt_refid = msg.m_refid;
1847
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001848 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1849 datapoint = &p->filter_datapoint[p->datapoint_idx];
1850 datapoint->d_recv_time = T4;
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001851 datapoint->d_offset = offset = ((T2 - T1) + (T3 - T4)) / 2;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001852 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001853 if (!p->reachable_bits) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001854 /* 1st datapoint ever - replicate offset in every element */
1855 int i;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001856 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001857 p->filter_datapoint[i].d_offset = offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001858 }
1859 }
1860
Denys Vlasenko0b002812010-01-03 08:59:59 +01001861 p->reachable_bits |= 1;
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01001862 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
Denys Vlasenko79bec062012-03-08 13:02:52 +01001863 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 +01001864 p->p_dotted,
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001865 offset,
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001866 p->lastpkt_delay,
1867 p->lastpkt_status,
1868 p->lastpkt_stratum,
1869 p->lastpkt_refid,
Denys Vlasenkod98dc922012-03-08 03:27:49 +01001870 p->lastpkt_rootdelay,
1871 p->reachable_bits
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001872 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1873 * m_reftime, m_orgtime, m_rectime, m_xmttime
1874 */
1875 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001876 }
1877
1878 /* Muck with statictics and update the clock */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001879 filter_datapoints(p);
1880 q = select_and_cluster();
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001881 rc = 0;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001882 if (q) {
Denys Vlasenko12628b72010-01-11 01:31:59 +01001883 if (!(option_mask32 & OPT_w)) {
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001884 rc = update_local_clock(q);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001885#if 0
1886//Disabled this because there is a case where largish offsets
1887//are unavoidable: if network round-trip delay is, say, ~0.6s,
1888//error in offset estimation would be ~delay/2 ~= 0.3s.
1889//Thus, offsets will be usually in -0.3...0.3s range.
1890//In this case, this code would keep poll interval small,
1891//but it won't be helping.
1892//BIGOFF check below deals with a case of seeing multi-second offsets.
1893
Denys Vlasenko12628b72010-01-11 01:31:59 +01001894 /* If drift is dangerously large, immediately
1895 * drop poll interval one step down.
1896 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001897 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001898 VERB4 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001899 adjust_poll(-POLLADJ_LIMIT * 3);
1900 rc = 0;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001901 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001902#endif
Denys Vlasenko12628b72010-01-11 01:31:59 +01001903 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001904 } else {
1905 /* No peer selected.
1906 * If poll interval is small, increase it.
1907 */
1908 if (G.poll_exp < BIGPOLL)
1909 goto increase_interval;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001910 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001911
1912 if (rc != 0) {
1913 /* Adjust the poll interval by comparing the current offset
1914 * with the clock jitter. If the offset is less than
1915 * the clock jitter times a constant, then the averaging interval
1916 * is increased, otherwise it is decreased. A bit of hysteresis
1917 * helps calm the dance. Works best using burst mode.
1918 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001919 if (rc > 0 && G.offset_to_jitter_ratio <= POLLADJ_GATE) {
Denys Vlasenkobfc2a322010-01-01 18:12:06 +01001920 /* was += G.poll_exp but it is a bit
1921 * too optimistic for my taste at high poll_exp's */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001922 increase_interval:
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001923 adjust_poll(MINPOLL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001924 } else {
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001925 adjust_poll(-G.poll_exp * 2);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001926 }
1927 }
1928
1929 /* Decide when to send new query for this peer */
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001930 pick_normal_interval:
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001931 interval = poll_interval(INT_MAX);
1932 if (fabs(offset) >= BIGOFF && interval > BIGOFF_INTERVAL) {
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001933 /* If we are synced, offsets are less than STEP_THRESHOLD,
1934 * or at the very least not much larger than it.
1935 * Now we see a largish one.
1936 * Either this peer is feeling bad, or packet got corrupted,
1937 * or _our_ clock is wrong now and _all_ peers will show similar
1938 * largish offsets too.
1939 * I observed this with laptop suspend stopping clock.
1940 * In any case, it makes sense to make next request soonish:
1941 * cases 1 and 2: get a better datapoint,
1942 * case 3: allows to resync faster.
1943 */
1944 interval = BIGOFF_INTERVAL;
1945 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001946
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001947 set_next(p, interval);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001948}
1949
1950#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01001951static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001952recv_and_process_client_pkt(void /*int fd*/)
1953{
1954 ssize_t size;
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02001955 //uint8_t version;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001956 len_and_sockaddr *to;
1957 struct sockaddr *from;
1958 msg_t msg;
1959 uint8_t query_status;
1960 l_fixedpt_t query_xmttime;
1961
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001962 to = get_sock_lsa(G_listen_fd);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001963 from = xzalloc(to->len);
1964
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001965 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 +01001966 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1967 char *addr;
1968 if (size < 0) {
1969 if (errno == EAGAIN)
1970 goto bail;
1971 bb_perror_msg_and_die("recv");
1972 }
1973 addr = xmalloc_sockaddr2dotted_noport(from);
1974 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1975 free(addr);
1976 goto bail;
1977 }
1978
1979 query_status = msg.m_status;
1980 query_xmttime = msg.m_xmttime;
1981
1982 /* Build a reply packet */
1983 memset(&msg, 0, sizeof(msg));
Paul Marksb7841cf2013-01-14 02:39:10 +01001984 msg.m_status = G.stratum < MAXSTRAT ? (G.ntp_status & LI_MASK) : LI_ALARM;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001985 msg.m_status |= (query_status & VERSION_MASK);
1986 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
Denys Vlasenko69675782013-01-14 01:34:48 +01001987 MODE_SERVER : MODE_SYM_PAS;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001988 msg.m_stratum = G.stratum;
1989 msg.m_ppoll = G.poll_exp;
1990 msg.m_precision_exp = G_precision_exp;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001991 /* this time was obtained between poll() and recv() */
1992 msg.m_rectime = d_to_lfp(G.cur_time);
1993 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
Denys Vlasenkod6782572010-10-04 01:20:44 +02001994 if (G.peer_cnt == 0) {
1995 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
1996 G.reftime = G.cur_time;
1997 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001998 msg.m_reftime = d_to_lfp(G.reftime);
1999 msg.m_orgtime = query_xmttime;
2000 msg.m_rootdelay = d_to_sfp(G.rootdelay);
2001//simple code does not do this, fix simple code!
2002 msg.m_rootdisp = d_to_sfp(G.rootdisp);
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02002003 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002004 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
2005
2006 /* We reply from the local address packet was sent to,
2007 * this makes to/from look swapped here: */
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002008 do_sendto(G_listen_fd,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002009 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
2010 &msg, size);
2011
2012 bail:
2013 free(to);
2014 free(from);
2015}
2016#endif
2017
2018/* Upstream ntpd's options:
2019 *
2020 * -4 Force DNS resolution of host names to the IPv4 namespace.
2021 * -6 Force DNS resolution of host names to the IPv6 namespace.
2022 * -a Require cryptographic authentication for broadcast client,
2023 * multicast client and symmetric passive associations.
2024 * This is the default.
2025 * -A Do not require cryptographic authentication for broadcast client,
2026 * multicast client and symmetric passive associations.
2027 * This is almost never a good idea.
2028 * -b Enable the client to synchronize to broadcast servers.
2029 * -c conffile
2030 * Specify the name and path of the configuration file,
2031 * default /etc/ntp.conf
2032 * -d Specify debugging mode. This option may occur more than once,
2033 * with each occurrence indicating greater detail of display.
2034 * -D level
2035 * Specify debugging level directly.
2036 * -f driftfile
2037 * Specify the name and path of the frequency file.
2038 * This is the same operation as the "driftfile FILE"
2039 * configuration command.
2040 * -g Normally, ntpd exits with a message to the system log
2041 * if the offset exceeds the panic threshold, which is 1000 s
2042 * by default. This option allows the time to be set to any value
2043 * without restriction; however, this can happen only once.
2044 * If the threshold is exceeded after that, ntpd will exit
2045 * with a message to the system log. This option can be used
2046 * with the -q and -x options. See the tinker command for other options.
2047 * -i jaildir
2048 * Chroot the server to the directory jaildir. This option also implies
2049 * that the server attempts to drop root privileges at startup
2050 * (otherwise, chroot gives very little additional security).
2051 * You may need to also specify a -u option.
2052 * -k keyfile
2053 * Specify the name and path of the symmetric key file,
2054 * default /etc/ntp/keys. This is the same operation
2055 * as the "keys FILE" configuration command.
2056 * -l logfile
2057 * Specify the name and path of the log file. The default
2058 * is the system log file. This is the same operation as
2059 * the "logfile FILE" configuration command.
2060 * -L Do not listen to virtual IPs. The default is to listen.
2061 * -n Don't fork.
2062 * -N To the extent permitted by the operating system,
2063 * run the ntpd at the highest priority.
2064 * -p pidfile
2065 * Specify the name and path of the file used to record the ntpd
2066 * process ID. This is the same operation as the "pidfile FILE"
2067 * configuration command.
2068 * -P priority
2069 * To the extent permitted by the operating system,
2070 * run the ntpd at the specified priority.
2071 * -q Exit the ntpd just after the first time the clock is set.
2072 * This behavior mimics that of the ntpdate program, which is
2073 * to be retired. The -g and -x options can be used with this option.
2074 * Note: The kernel time discipline is disabled with this option.
2075 * -r broadcastdelay
2076 * Specify the default propagation delay from the broadcast/multicast
2077 * server to this client. This is necessary only if the delay
2078 * cannot be computed automatically by the protocol.
2079 * -s statsdir
2080 * Specify the directory path for files created by the statistics
2081 * facility. This is the same operation as the "statsdir DIR"
2082 * configuration command.
2083 * -t key
2084 * Add a key number to the trusted key list. This option can occur
2085 * more than once.
2086 * -u user[:group]
2087 * Specify a user, and optionally a group, to switch to.
2088 * -v variable
2089 * -V variable
2090 * Add a system variable listed by default.
2091 * -x Normally, the time is slewed if the offset is less than the step
2092 * threshold, which is 128 ms by default, and stepped if above
2093 * the threshold. This option sets the threshold to 600 s, which is
2094 * well within the accuracy window to set the clock manually.
2095 * Note: since the slew rate of typical Unix kernels is limited
2096 * to 0.5 ms/s, each second of adjustment requires an amortization
2097 * interval of 2000 s. Thus, an adjustment as much as 600 s
2098 * will take almost 14 days to complete. This option can be used
2099 * with the -g and -q options. See the tinker command for other options.
2100 * Note: The kernel time discipline is disabled with this option.
2101 */
2102
2103/* By doing init in a separate function we decrease stack usage
2104 * in main loop.
2105 */
2106static NOINLINE void ntp_init(char **argv)
2107{
2108 unsigned opts;
2109 llist_t *peers;
2110
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01002111 srand(getpid());
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002112
2113 if (getuid())
2114 bb_error_msg_and_die(bb_msg_you_must_be_root);
2115
2116 /* Set some globals */
Miroslav Lichvar760d0352014-10-05 03:10:15 +02002117 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002118 G.stratum = MAXSTRAT;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002119 if (BURSTPOLL != 0)
2120 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002121 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002122
2123 /* Parse options */
2124 peers = NULL;
Denys Vlasenko278842d2014-07-15 15:06:54 +02002125 opt_complementary = "dd:p::wn" /* -d: counter; -p: list; -w implies -n */
2126 IF_FEATURE_NTPD_SERVER(":Il"); /* -I implies -l */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002127 opts = getopt32(argv,
2128 "nqNx" /* compat */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002129 "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
Denys Vlasenko278842d2014-07-15 15:06:54 +02002130 IF_FEATURE_NTPD_SERVER("I:") /* compat */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002131 "d" /* compat */
2132 "46aAbgL", /* compat, ignored */
Denys Vlasenko278842d2014-07-15 15:06:54 +02002133 &peers,&G.script_name,
2134#if ENABLE_FEATURE_NTPD_SERVER
2135 &G.if_name,
2136#endif
2137 &G.verbose);
Denys Vlasenko504fe452014-03-23 15:06:38 +01002138
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002139// if (opts & OPT_x) /* disable stepping, only slew is allowed */
2140// G.time_was_stepped = 1;
Denys Vlasenkod6782572010-10-04 01:20:44 +02002141 if (peers) {
2142 while (peers)
2143 add_peers(llist_pop(&peers));
Denys Vlasenko504fe452014-03-23 15:06:38 +01002144 }
2145#if ENABLE_FEATURE_NTPD_CONF
2146 else {
2147 parser_t *parser;
2148 char *token[3];
2149
2150 parser = config_open("/etc/ntp.conf");
2151 while (config_read(parser, token, 3, 1, "# \t", PARSE_NORMAL)) {
2152 if (strcmp(token[0], "server") == 0 && token[1]) {
2153 add_peers(token[1]);
2154 continue;
2155 }
2156 bb_error_msg("skipping %s:%u: unimplemented command '%s'",
2157 "/etc/ntp.conf", parser->lineno, token[0]
2158 );
2159 }
2160 config_close(parser);
2161 }
2162#endif
2163 if (G.peer_cnt == 0) {
2164 if (!(opts & OPT_l))
2165 bb_show_usage();
Denys Vlasenkod6782572010-10-04 01:20:44 +02002166 /* -l but no peers: "stratum 1 server" mode */
2167 G.stratum = 1;
2168 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002169#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002170 G_listen_fd = -1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002171 if (opts & OPT_l) {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002172 G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
Denys Vlasenko278842d2014-07-15 15:06:54 +02002173 if (opts & OPT_I) {
2174 if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
2175 xfunc_die();
2176 }
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002177 socket_want_pktinfo(G_listen_fd);
2178 setsockopt(G_listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002179 }
2180#endif
Denys Vlasenko278842d2014-07-15 15:06:54 +02002181 if (!(opts & OPT_n)) {
2182 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
2183 logmode = LOGMODE_NONE;
2184 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002185 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
2186 if (opts & OPT_N)
2187 setpriority(PRIO_PROCESS, 0, -15);
2188
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002189 /* If network is up, syncronization occurs in ~10 seconds.
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002190 * We give "ntpd -q" 10 seconds to get first reply,
2191 * then another 50 seconds to finish syncing.
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002192 *
2193 * I tested ntpd 4.2.6p1 and apparently it never exits
2194 * (will try forever), but it does not feel right.
2195 * The goal of -q is to act like ntpdate: set time
2196 * after a reasonably small period of polling, or fail.
2197 */
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002198 if (opts & OPT_q) {
2199 option_mask32 |= OPT_qq;
2200 alarm(10);
2201 }
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002202
2203 bb_signals(0
2204 | (1 << SIGTERM)
2205 | (1 << SIGINT)
2206 | (1 << SIGALRM)
2207 , record_signo
2208 );
2209 bb_signals(0
2210 | (1 << SIGPIPE)
2211 | (1 << SIGCHLD)
2212 , SIG_IGN
2213 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002214}
2215
2216int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2217int ntpd_main(int argc UNUSED_PARAM, char **argv)
2218{
Denys Vlasenko0b002812010-01-03 08:59:59 +01002219#undef G
2220 struct globals G;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002221 struct pollfd *pfd;
2222 peer_t **idx2peer;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002223 unsigned cnt;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002224
Denys Vlasenko0b002812010-01-03 08:59:59 +01002225 memset(&G, 0, sizeof(G));
2226 SET_PTR_TO_GLOBALS(&G);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002227
2228 ntp_init(argv);
2229
Denys Vlasenko0b002812010-01-03 08:59:59 +01002230 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2231 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2232 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2233 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2234
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002235 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002236 * packets to each peer.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002237 * NB: if some peer is not responding, we may end up sending
2238 * fewer packets to it and more to other peers.
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002239 * NB2: sync usually happens using INITIAL_SAMPLES packets,
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002240 * since last reply does not come back instantaneously.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002241 */
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002242 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002243
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002244 write_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2245
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002246 while (!bb_got_signal) {
2247 llist_t *item;
2248 unsigned i, j;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002249 int nfds, timeout;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002250 double nextaction;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002251
2252 /* Nothing between here and poll() blocks for any significant time */
2253
Denys Vlasenko0b002812010-01-03 08:59:59 +01002254 nextaction = G.cur_time + 3600;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002255
2256 i = 0;
2257#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002258 if (G_listen_fd != -1) {
2259 pfd[0].fd = G_listen_fd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002260 pfd[0].events = POLLIN;
2261 i++;
2262 }
2263#endif
2264 /* Pass over peer list, send requests, time out on receives */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002265 for (item = G.ntp_peers; item != NULL; item = item->link) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002266 peer_t *p = (peer_t *) item->data;
2267
Denys Vlasenko0b002812010-01-03 08:59:59 +01002268 if (p->next_action_time <= G.cur_time) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002269 if (p->p_fd == -1) {
2270 /* Time to send new req */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002271 if (--cnt == 0) {
Miroslav Lichvarfb143f72014-09-18 16:19:03 +02002272 VERB4 bb_error_msg("disabling burst mode");
2273 G.polladj_count = 0;
2274 G.poll_exp = MINPOLL;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002275 G.initial_poll_complete = 1;
2276 }
2277 send_query_to_peer(p);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002278 } else {
2279 /* Timed out waiting for reply */
2280 close(p->p_fd);
2281 p->p_fd = -1;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002282 /* If poll interval is small, increase it */
2283 if (G.poll_exp < BIGPOLL)
2284 adjust_poll(MINPOLL);
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002285 timeout = poll_interval(NOREPLY_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002286 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
Denys Vlasenko0b002812010-01-03 08:59:59 +01002287 p->p_dotted, p->reachable_bits, timeout);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002288 set_next(p, timeout);
2289 }
2290 }
2291
2292 if (p->next_action_time < nextaction)
2293 nextaction = p->next_action_time;
2294
2295 if (p->p_fd >= 0) {
2296 /* Wait for reply from this peer */
2297 pfd[i].fd = p->p_fd;
2298 pfd[i].events = POLLIN;
2299 idx2peer[i] = p;
2300 i++;
2301 }
2302 }
2303
Denys Vlasenko0b002812010-01-03 08:59:59 +01002304 timeout = nextaction - G.cur_time;
2305 if (timeout < 0)
2306 timeout = 0;
2307 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002308
2309 /* Here we may block */
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002310 VERB2 {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002311 if (i > (ENABLE_FEATURE_NTPD_SERVER && G_listen_fd != -1)) {
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002312 /* We wait for at least one reply.
2313 * Poll for it, without wasting time for message.
2314 * Since replies often come under 1 second, this also
2315 * reduces clutter in logs.
2316 */
2317 nfds = poll(pfd, i, 1000);
2318 if (nfds != 0)
2319 goto did_poll;
2320 if (--timeout <= 0)
2321 goto did_poll;
2322 }
Denys Vlasenko8be49c32012-03-06 19:16:50 +01002323 bb_error_msg("poll:%us sockets:%u interval:%us", timeout, i, 1 << G.poll_exp);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002324 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002325 nfds = poll(pfd, i, timeout * 1000);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002326 did_poll:
Denys Vlasenko0b002812010-01-03 08:59:59 +01002327 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002328 if (nfds <= 0) {
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002329 if (!bb_got_signal /* poll wasn't interrupted by a signal */
2330 && G.cur_time - G.last_script_run > 11*60
2331 ) {
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002332 /* Useful for updating battery-backed RTC and such */
Denys Vlasenko12628b72010-01-11 01:31:59 +01002333 run_script("periodic", G.last_update_offset);
Denys Vlasenko06667f22010-01-06 13:05:08 +01002334 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002335 }
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002336 goto check_unsync;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002337 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002338
2339 /* Process any received packets */
2340 j = 0;
2341#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01002342 if (G.listen_fd != -1) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002343 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2344 nfds--;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002345 recv_and_process_client_pkt(/*G.listen_fd*/);
2346 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002347 }
2348 j = 1;
2349 }
2350#endif
2351 for (; nfds != 0 && j < i; j++) {
2352 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002353 /*
2354 * At init, alarm was set to 10 sec.
2355 * Now we did get a reply.
2356 * Increase timeout to 50 seconds to finish syncing.
2357 */
2358 if (option_mask32 & OPT_qq) {
2359 option_mask32 &= ~OPT_qq;
2360 alarm(50);
2361 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002362 nfds--;
2363 recv_and_process_peer_pkt(idx2peer[j]);
Denys Vlasenko0b002812010-01-03 08:59:59 +01002364 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002365 }
2366 }
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002367
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002368 check_unsync:
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002369 if (G.ntp_peers && G.stratum != MAXSTRAT) {
2370 for (item = G.ntp_peers; item != NULL; item = item->link) {
2371 peer_t *p = (peer_t *) item->data;
2372 if (p->reachable_bits)
2373 goto have_reachable_peer;
2374 }
2375 /* No peer responded for last 8 packets, panic */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002376 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02002377 run_script("unsync", 0.0);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002378 have_reachable_peer: ;
2379 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002380 } /* while (!bb_got_signal) */
2381
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002382 remove_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002383 kill_myself_with_sig(bb_got_signal);
2384}
2385
2386
2387
2388
2389
2390
2391/*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2392
2393/*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2394
2395#if 0
2396static double
2397direct_freq(double fp_offset)
2398{
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002399#ifdef KERNEL_PLL
2400 /*
2401 * If the kernel is enabled, we need the residual offset to
2402 * calculate the frequency correction.
2403 */
2404 if (pll_control && kern_enable) {
2405 memset(&ntv, 0, sizeof(ntv));
2406 ntp_adjtime(&ntv);
2407#ifdef STA_NANO
2408 clock_offset = ntv.offset / 1e9;
2409#else /* STA_NANO */
2410 clock_offset = ntv.offset / 1e6;
2411#endif /* STA_NANO */
2412 drift_comp = FREQTOD(ntv.freq);
2413 }
2414#endif /* KERNEL_PLL */
2415 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2416 wander_resid = 0;
2417 return drift_comp;
2418}
2419
2420static void
Denys Vlasenkofb132e42010-10-29 11:46:52 +02002421set_freq(double freq) /* frequency update */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002422{
2423 char tbuf[80];
2424
2425 drift_comp = freq;
2426
2427#ifdef KERNEL_PLL
2428 /*
2429 * If the kernel is enabled, update the kernel frequency.
2430 */
2431 if (pll_control && kern_enable) {
2432 memset(&ntv, 0, sizeof(ntv));
2433 ntv.modes = MOD_FREQUENCY;
2434 ntv.freq = DTOFREQ(drift_comp);
2435 ntp_adjtime(&ntv);
2436 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2437 report_event(EVNT_FSET, NULL, tbuf);
2438 } else {
2439 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2440 report_event(EVNT_FSET, NULL, tbuf);
2441 }
2442#else /* KERNEL_PLL */
2443 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2444 report_event(EVNT_FSET, NULL, tbuf);
2445#endif /* KERNEL_PLL */
2446}
2447
2448...
2449...
2450...
2451
2452#ifdef KERNEL_PLL
2453 /*
2454 * This code segment works when clock adjustments are made using
2455 * precision time kernel support and the ntp_adjtime() system
2456 * call. This support is available in Solaris 2.6 and later,
2457 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2458 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2459 * DECstation 5000/240 and Alpha AXP, additional kernel
2460 * modifications provide a true microsecond clock and nanosecond
2461 * clock, respectively.
2462 *
2463 * Important note: The kernel discipline is used only if the
2464 * step threshold is less than 0.5 s, as anything higher can
2465 * lead to overflow problems. This might occur if some misguided
2466 * lad set the step threshold to something ridiculous.
2467 */
2468 if (pll_control && kern_enable) {
2469
2470#define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2471
2472 /*
2473 * We initialize the structure for the ntp_adjtime()
2474 * system call. We have to convert everything to
2475 * microseconds or nanoseconds first. Do not update the
2476 * system variables if the ext_enable flag is set. In
2477 * this case, the external clock driver will update the
2478 * variables, which will be read later by the local
2479 * clock driver. Afterwards, remember the time and
2480 * frequency offsets for jitter and stability values and
2481 * to update the frequency file.
2482 */
2483 memset(&ntv, 0, sizeof(ntv));
2484 if (ext_enable) {
2485 ntv.modes = MOD_STATUS;
2486 } else {
2487#ifdef STA_NANO
2488 ntv.modes = MOD_BITS | MOD_NANO;
2489#else /* STA_NANO */
2490 ntv.modes = MOD_BITS;
2491#endif /* STA_NANO */
2492 if (clock_offset < 0)
2493 dtemp = -.5;
2494 else
2495 dtemp = .5;
2496#ifdef STA_NANO
2497 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2498 ntv.constant = sys_poll;
2499#else /* STA_NANO */
2500 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2501 ntv.constant = sys_poll - 4;
2502#endif /* STA_NANO */
2503 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2504 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2505 ntv.status = STA_PLL;
2506
2507 /*
2508 * Enable/disable the PPS if requested.
2509 */
2510 if (pps_enable) {
2511 if (!(pll_status & STA_PPSTIME))
2512 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002513 NULL, "PPS enabled");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002514 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2515 } else {
2516 if (pll_status & STA_PPSTIME)
2517 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002518 NULL, "PPS disabled");
2519 ntv.status &= ~(STA_PPSTIME | STA_PPSFREQ);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002520 }
2521 if (sys_leap == LEAP_ADDSECOND)
2522 ntv.status |= STA_INS;
2523 else if (sys_leap == LEAP_DELSECOND)
2524 ntv.status |= STA_DEL;
2525 }
2526
2527 /*
2528 * Pass the stuff to the kernel. If it squeals, turn off
2529 * the pps. In any case, fetch the kernel offset,
2530 * frequency and jitter.
2531 */
2532 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2533 if (!(ntv.status & STA_PPSSIGNAL))
2534 report_event(EVNT_KERN, NULL,
Denys Vlasenko69675782013-01-14 01:34:48 +01002535 "PPS no signal");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002536 }
2537 pll_status = ntv.status;
2538#ifdef STA_NANO
2539 clock_offset = ntv.offset / 1e9;
2540#else /* STA_NANO */
2541 clock_offset = ntv.offset / 1e6;
2542#endif /* STA_NANO */
2543 clock_frequency = FREQTOD(ntv.freq);
2544
2545 /*
2546 * If the kernel PPS is lit, monitor its performance.
2547 */
2548 if (ntv.status & STA_PPSTIME) {
2549#ifdef STA_NANO
2550 clock_jitter = ntv.jitter / 1e9;
2551#else /* STA_NANO */
2552 clock_jitter = ntv.jitter / 1e6;
2553#endif /* STA_NANO */
2554 }
2555
2556#if defined(STA_NANO) && NTP_API == 4
2557 /*
2558 * If the TAI changes, update the kernel TAI.
2559 */
2560 if (loop_tai != sys_tai) {
2561 loop_tai = sys_tai;
2562 ntv.modes = MOD_TAI;
2563 ntv.constant = sys_tai;
2564 ntp_adjtime(&ntv);
2565 }
2566#endif /* STA_NANO */
2567 }
2568#endif /* KERNEL_PLL */
2569#endif