blob: 041cac76265370a520730666fa1b346b844b4012 [file] [log] [blame]
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001/*
2 * NTP client/server, based on OpenNTPD 3.9p1
3 *
Adam Tkac4bf88d92015-01-04 17:46:08 +01004 * Busybox port author: Adam Tkac (C) 2009 <vonsch@gmail.com>
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01005 *
Adam Tkac4bf88d92015-01-04 17:46:08 +01006 * OpenNTPd 3.9p1 copyright holders:
7 * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
8 * Copyright (c) 2004 Alexander Guy <alexander.guy@andern.org>
9 *
10 * OpenNTPd code is licensed under ISC-style licence:
11 *
12 * Permission to use, copy, modify, and distribute this software for any
13 * purpose with or without fee is hereby granted, provided that the above
14 * copyright notice and this permission notice appear in all copies.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
21 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
22 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 ***********************************************************************
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010024 *
25 * Parts of OpenNTPD clock syncronization code is replaced by
Adam Tkac4bf88d92015-01-04 17:46:08 +010026 * code which is based on ntp-4.2.6, which carries the following
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010027 * copyright notice:
28 *
Adam Tkac4bf88d92015-01-04 17:46:08 +010029 * Copyright (c) University of Delaware 1992-2009
30 *
31 * Permission to use, copy, modify, and distribute this software and
32 * its documentation for any purpose with or without fee is hereby
33 * granted, provided that the above copyright notice appears in all
34 * copies and that both the copyright notice and this permission
35 * notice appear in supporting documentation, and that the name
36 * University of Delaware not be used in advertising or publicity
37 * pertaining to distribution of the software without specific,
38 * written prior permission. The University of Delaware makes no
39 * representations about the suitability this software for any
40 * purpose. It is provided "as is" without express or implied warranty.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010041 ***********************************************************************
42 */
Denys Vlasenko47367e12016-11-23 09:05:14 +010043//config:config NTPD
Denys Vlasenko4eed2c62017-07-18 22:01:24 +020044//config: bool "ntpd (17 kb)"
Denys Vlasenko47367e12016-11-23 09:05:14 +010045//config: default y
46//config: select PLATFORM_LINUX
47//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020048//config: The NTP client/server daemon.
Denys Vlasenko47367e12016-11-23 09:05:14 +010049//config:
50//config:config FEATURE_NTPD_SERVER
51//config: bool "Make ntpd usable as a NTP server"
52//config: default y
53//config: depends on NTPD
54//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020055//config: Make ntpd usable as a NTP server. If you disable this option
56//config: ntpd will be usable only as a NTP client.
Denys Vlasenko47367e12016-11-23 09:05:14 +010057//config:
58//config:config FEATURE_NTPD_CONF
59//config: bool "Make ntpd understand /etc/ntp.conf"
60//config: default y
61//config: depends on NTPD
62//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020063//config: Make ntpd look in /etc/ntp.conf for peers. Only "server address"
64//config: is supported.
Denys Vlasenko63d053d2018-10-30 23:07:26 +010065//config:
Brandon P. Enochsa5413142018-10-27 18:55:59 +020066//config:config FEATURE_NTP_AUTH
67//config: bool "Support md5/sha1 message authentication codes"
Denys Vlasenko63d053d2018-10-30 23:07:26 +010068//config: default y
Brandon P. Enochsa5413142018-10-27 18:55:59 +020069//config: depends on NTPD
Denys Vlasenko47367e12016-11-23 09:05:14 +010070
71//applet:IF_NTPD(APPLET(ntpd, BB_DIR_USR_SBIN, BB_SUID_DROP))
72
73//kbuild:lib-$(CONFIG_NTPD) += ntpd.o
Pere Orga5bc8c002011-04-11 03:29:49 +020074
75//usage:#define ntpd_trivial_usage
Brandon P. Enochsa5413142018-10-27 18:55:59 +020076//usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l] [-I IFACE")"] [-S PROG]"
77//usage: IF_NOT_FEATURE_NTP_AUTH(" [-p PEER]...")
78//usage: IF_FEATURE_NTP_AUTH(" [-k KEYFILE] [-p [keyno:N:]PEER]...")
Pere Orga5bc8c002011-04-11 03:29:49 +020079//usage:#define ntpd_full_usage "\n\n"
80//usage: "NTP client/server\n"
Denys Vlasenko59a56042017-10-31 12:47:07 +010081//usage: "\n -d Verbose (may be repeated)"
Pere Orga5bc8c002011-04-11 03:29:49 +020082//usage: "\n -n Do not daemonize"
83//usage: "\n -q Quit after clock is set"
84//usage: "\n -N Run at high priority"
85//usage: "\n -w Do not set time (only query peers), implies -n"
Brandon P. Enochsa5413142018-10-27 18:55:59 +020086//usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 min"
87//usage: IF_NOT_FEATURE_NTP_AUTH(
Pere Orga5bc8c002011-04-11 03:29:49 +020088//usage: "\n -p PEER Obtain time from PEER (may be repeated)"
Brandon P. Enochsa5413142018-10-27 18:55:59 +020089//usage: )
90//usage: IF_FEATURE_NTP_AUTH(
91//usage: "\n -k FILE Key file (ntp.keys compatible)"
92//usage: "\n -p [keyno:NUM:]PEER"
93//usage: "\n Obtain time from PEER (may be repeated)"
94//usage: "\n Use key NUM for authentication"
95//usage: )
Denys Vlasenko504fe452014-03-23 15:06:38 +010096//usage: IF_FEATURE_NTPD_CONF(
Denys Vlasenko3c31b092015-03-05 14:04:44 +010097//usage: "\n If -p is not given, 'server HOST' lines"
98//usage: "\n from /etc/ntp.conf are used"
Denys Vlasenko504fe452014-03-23 15:06:38 +010099//usage: )
Denys Vlasenko3aef8142015-03-02 20:59:13 +0100100//usage: IF_FEATURE_NTPD_SERVER(
101//usage: "\n -l Also run as server on port 123"
102//usage: "\n -I IFACE Bind server to IFACE, implies -l"
103//usage: )
Denys Vlasenko504fe452014-03-23 15:06:38 +0100104
105// -l and -p options are not compatible with "standard" ntpd:
106// it has them as "-l logfile" and "-p pidfile".
107// -S and -w are not compat either, "standard" ntpd has no such opts.
Pere Orga5bc8c002011-04-11 03:29:49 +0200108
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100109#include "libbb.h"
110#include <math.h>
Codarren Velvindron7c43d432018-04-15 20:37:50 +0400111#include <netinet/ip.h> /* For IPTOS_DSCP_AF21 definition */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100112#include <sys/timex.h>
Codarren Velvindron7c43d432018-04-15 20:37:50 +0400113#ifndef IPTOS_DSCP_AF21
114# define IPTOS_DSCP_AF21 0x48
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100115#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100116
117
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100118/* Verbosity control (max level of -dddd options accepted).
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100119 * max 6 is very talkative (and bloated). 3 is non-bloated,
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100120 * production level setting.
121 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100122#define MAX_VERBOSE 3
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100123
124
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100125/* High-level description of the algorithm:
126 *
127 * We start running with very small poll_exp, BURSTPOLL,
Leonid Lisovskiy894ef602010-10-20 22:36:51 +0200128 * in order to quickly accumulate INITIAL_SAMPLES datapoints
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100129 * for each peer. Then, time is stepped if the offset is larger
130 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
131 * poll_exp to MINPOLL and enter frequency measurement step:
132 * we collect new datapoints but ignore them for WATCH_THRESHOLD
133 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
134 * offset and estimate frequency drift.
135 *
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100136 * (frequency measurement step seems to not be strictly needed,
137 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
138 * define set to 0)
139 *
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100140 * After this, we enter "steady state": we collect a datapoint,
141 * we select the best peer, if this datapoint is not a new one
142 * (IOW: if this datapoint isn't for selected peer), sleep
143 * and collect another one; otherwise, use its offset to update
144 * frequency drift, if offset is somewhat large, reduce poll_exp,
145 * otherwise increase poll_exp.
146 *
147 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
148 * happen, we assume that something "bad" happened (computer
149 * was hibernated, someone set totally wrong date, etc),
150 * then the time is stepped, all datapoints are discarded,
151 * and we go back to steady state.
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100152 *
153 * Made some changes to speed up re-syncing after our clock goes bad
154 * (tested with suspending my laptop):
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100155 * - if largish offset (>= STEP_THRESHOLD == 1 sec) is seen
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100156 * from a peer, schedule next query for this peer soon
157 * without drastically lowering poll interval for everybody.
158 * This makes us collect enough data for step much faster:
159 * e.g. at poll = 10 (1024 secs), step was done within 5 minutes
160 * after first reply which indicated that our clock is 14 seconds off.
161 * - on step, do not discard d_dispersion data of the existing datapoints,
162 * do not clear reachable_bits. This prevents discarding first ~8
163 * datapoints after the step.
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100164 */
165
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100166#define INITIAL_SAMPLES 4 /* how many samples do we want for init */
Denys Vlasenko79153cb2018-07-25 14:58:49 +0200167#define MIN_FREQHOLD 12 /* adjust offset, but not freq in this many first adjustments */
Denys Vlasenko9b1c8bf2018-08-03 11:03:55 +0200168#define BAD_DELAY_GROWTH 4 /* drop packet if its delay grew by more than this factor */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100169
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200170#define RETRY_INTERVAL 32 /* on send/recv error, retry in N secs (need to be power of 2) */
171#define NOREPLY_INTERVAL 512 /* sent, but got no reply: cap next query by this many seconds */
172#define RESPONSE_INTERVAL 16 /* wait for reply up to N secs */
Denys Vlasenko6a4f2232017-10-31 12:44:37 +0100173#define HOSTNAME_INTERVAL 4 /* hostname lookup failed. Wait N * peer->dns_errors secs for next try */
174#define DNS_ERRORS_CAP 0x3f /* peer->dns_errors is in [0..63] */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100175
176/* Step threshold (sec). std ntpd uses 0.128.
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100177 */
178#define STEP_THRESHOLD 1
179/* Slew threshold (sec): adjtimex() won't accept offsets larger than this.
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200180 * Using exact power of 2 (1/8) results in smaller code
181 */
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100182#define SLEW_THRESHOLD 0.125
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +0100183//^^^^^^^^^^^^^^^^^^^^^^^^^^ TODO: man adjtimex about tmx.offset:
184// "Since Linux 2.6.26, the supplied value is clamped to the range (-0.5s, +0.5s)"
185// - can use this larger value instead?
186
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200187/* Stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +0100188//UNUSED: #define WATCH_THRESHOLD 128
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100189/* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100190//UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100191
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200192/*
193 * If we got |offset| > BIGOFF from a peer, cap next query interval
194 * for this peer by this many seconds:
195 */
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100196#define BIGOFF STEP_THRESHOLD
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200197#define BIGOFF_INTERVAL (1 << 7) /* 128 s */
198
Denys Vlasenko12628b72010-01-11 01:31:59 +0100199#define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
Denys Vlasenkofb132e42010-10-29 11:46:52 +0200200#define BURSTPOLL 0 /* initial poll */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100201#define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200202/*
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200203 * If offset > discipline_jitter * POLLADJ_GATE, and poll interval is > 2^BIGPOLL,
204 * then it is decreased _at once_. (If <= 2^BIGPOLL, it will be decreased _eventually_).
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100205 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200206#define BIGPOLL 9 /* 2^9 sec ~= 8.5 min */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100207#define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200208/*
209 * Actively lower poll when we see such big offsets.
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100210 * With SLEW_THRESHOLD = 0.125, it means we try to sync more aggressively
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200211 * if offset increases over ~0.04 sec
212 */
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100213//#define POLLDOWN_OFFSET (SLEW_THRESHOLD / 3)
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100214#define MINDISP 0.01 /* minimum dispersion (sec) */
215#define MAXDISP 16 /* maximum dispersion (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100216#define MAXSTRAT 16 /* maximum stratum (infinity metric) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100217#define MAXDIST 1 /* distance threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100218#define MIN_SELECTED 1 /* minimum intersection survivors */
219#define MIN_CLUSTERED 3 /* minimum cluster survivors */
220
221#define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100222
223/* Poll-adjust threshold.
224 * When we see that offset is small enough compared to discipline jitter,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100225 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
Denys Vlasenko61313112010-01-01 19:56:16 +0100226 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100227 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
228 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100229 */
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100230#define POLLADJ_LIMIT 40
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100231/* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100232 * poll interval (we think we can't improve timekeeping
233 * by staying at smaller poll).
234 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100235#define POLLADJ_GATE 4
Denys Vlasenko132b0442012-03-05 00:51:48 +0100236#define TIMECONST_HACK_GATE 2
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100237/* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100238#define ALLAN 512
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100239/* PLL loop gain */
Denys Vlasenko61313112010-01-01 19:56:16 +0100240#define PLL 65536
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100241/* FLL loop gain [why it depends on MAXPOLL??] */
Denys Vlasenko61313112010-01-01 19:56:16 +0100242#define FLL (MAXPOLL + 1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100243/* Parameter averaging constant */
Denys Vlasenko61313112010-01-01 19:56:16 +0100244#define AVG 4
245
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200246#define MAX_KEY_NUMBER 65535
247#define KEYID_SIZE sizeof(uint32_t)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100248
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100249enum {
250 NTP_VERSION = 4,
251 NTP_MAXSTRATUM = 15,
252
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200253 NTP_MD5_DIGESTSIZE = 16,
254 NTP_MSGSIZE_NOAUTH = 48,
255 NTP_MSGSIZE_MD5_AUTH = NTP_MSGSIZE_NOAUTH + KEYID_SIZE + NTP_MD5_DIGESTSIZE,
256 NTP_SHA1_DIGESTSIZE = 20,
257 NTP_MSGSIZE_SHA1_AUTH = NTP_MSGSIZE_NOAUTH + KEYID_SIZE + NTP_SHA1_DIGESTSIZE,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100258
259 /* Status Masks */
260 MODE_MASK = (7 << 0),
261 VERSION_MASK = (7 << 3),
262 VERSION_SHIFT = 3,
263 LI_MASK = (3 << 6),
264
265 /* Leap Second Codes (high order two bits of m_status) */
266 LI_NOWARNING = (0 << 6), /* no warning */
267 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
268 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
269 LI_ALARM = (3 << 6), /* alarm condition */
270
271 /* Mode values */
272 MODE_RES0 = 0, /* reserved */
273 MODE_SYM_ACT = 1, /* symmetric active */
274 MODE_SYM_PAS = 2, /* symmetric passive */
275 MODE_CLIENT = 3, /* client */
276 MODE_SERVER = 4, /* server */
277 MODE_BROADCAST = 5, /* broadcast */
278 MODE_RES1 = 6, /* reserved for NTP control message */
279 MODE_RES2 = 7, /* reserved for private use */
280};
281
282//TODO: better base selection
283#define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
284
285#define NUM_DATAPOINTS 8
286
287typedef struct {
288 uint32_t int_partl;
289 uint32_t fractionl;
290} l_fixedpt_t;
291
292typedef struct {
293 uint16_t int_parts;
294 uint16_t fractions;
295} s_fixedpt_t;
296
297typedef struct {
298 uint8_t m_status; /* status of local clock and leap info */
299 uint8_t m_stratum;
300 uint8_t m_ppoll; /* poll value */
301 int8_t m_precision_exp;
302 s_fixedpt_t m_rootdelay;
303 s_fixedpt_t m_rootdisp;
304 uint32_t m_refid;
305 l_fixedpt_t m_reftime;
306 l_fixedpt_t m_orgtime;
307 l_fixedpt_t m_rectime;
308 l_fixedpt_t m_xmttime;
309 uint32_t m_keyid;
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200310 uint8_t m_digest[ENABLE_FEATURE_NTP_AUTH ? NTP_SHA1_DIGESTSIZE : NTP_MD5_DIGESTSIZE];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100311} msg_t;
312
313typedef struct {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100314 double d_offset;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100315 double d_recv_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100316 double d_dispersion;
317} datapoint_t;
318
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200319#if ENABLE_FEATURE_NTP_AUTH
320enum {
321 HASH_MD5,
322 HASH_SHA1,
323};
324typedef struct {
325 unsigned id; //try uint16_t?
326 smalluint type;
327 smalluint msg_size;
328 smalluint key_length;
329 char key[0];
330} key_entry_t;
331#endif
332
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100333typedef struct {
334 len_and_sockaddr *p_lsa;
335 char *p_dotted;
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200336#if ENABLE_FEATURE_NTP_AUTH
337 key_entry_t *key_entry;
338#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100339 int p_fd;
340 int datapoint_idx;
341 uint32_t lastpkt_refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100342 uint8_t lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100343 uint8_t lastpkt_stratum;
Denys Vlasenko0b002812010-01-03 08:59:59 +0100344 uint8_t reachable_bits;
Denys Vlasenko6a4f2232017-10-31 12:44:37 +0100345 uint8_t dns_errors;
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200346 /* when to send new query (if p_fd == -1)
347 * or when receive times out (if p_fd >= 0): */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100348 double next_action_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100349 double p_xmttime;
Denys Vlasenkod531f932014-04-19 19:00:16 +0200350 double p_raw_delay;
351 /* p_raw_delay is set even by "high delay" packets */
352 /* lastpkt_delay isn't */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100353 double lastpkt_recv_time;
354 double lastpkt_delay;
355 double lastpkt_rootdelay;
356 double lastpkt_rootdisp;
357 /* produced by filter algorithm: */
358 double filter_offset;
359 double filter_dispersion;
360 double filter_jitter;
361 datapoint_t filter_datapoint[NUM_DATAPOINTS];
362 /* last sent packet: */
363 msg_t p_xmt_msg;
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200364 char p_hostname[1];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100365} peer_t;
366
367
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100368#define USING_KERNEL_PLL_LOOP 1
369#define USING_INITIAL_FREQ_ESTIMATION 0
370
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100371enum {
372 OPT_n = (1 << 0),
373 OPT_q = (1 << 1),
374 OPT_N = (1 << 2),
375 OPT_x = (1 << 3),
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200376 OPT_k = (1 << 4) * ENABLE_FEATURE_NTP_AUTH,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100377 /* Insert new options above this line. */
378 /* Non-compat options: */
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200379 OPT_w = (1 << (4+ENABLE_FEATURE_NTP_AUTH)),
380 OPT_p = (1 << (5+ENABLE_FEATURE_NTP_AUTH)),
381 OPT_S = (1 << (6+ENABLE_FEATURE_NTP_AUTH)),
382 OPT_l = (1 << (7+ENABLE_FEATURE_NTP_AUTH)) * ENABLE_FEATURE_NTPD_SERVER,
383 OPT_I = (1 << (8+ENABLE_FEATURE_NTP_AUTH)) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko8e23faf2011-04-07 01:45:20 +0200384 /* We hijack some bits for other purposes */
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100385 OPT_qq = (1 << 31),
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100386};
387
388struct globals {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100389 double cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100390 /* total round trip delay to currently selected reference clock */
391 double rootdelay;
392 /* reference timestamp: time when the system clock was last set or corrected */
393 double reftime;
394 /* total dispersion to currently selected reference clock */
395 double rootdisp;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100396
397 double last_script_run;
398 char *script_name;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100399 llist_t *ntp_peers;
400#if ENABLE_FEATURE_NTPD_SERVER
401 int listen_fd;
Denys Vlasenko278842d2014-07-15 15:06:54 +0200402 char *if_name;
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +0200403# define G_listen_fd (G.listen_fd)
404#else
405# define G_listen_fd (-1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100406#endif
407 unsigned verbose;
408 unsigned peer_cnt;
409 /* refid: 32-bit code identifying the particular server or reference clock
Denys Vlasenko74584b82012-03-02 01:22:40 +0100410 * in stratum 0 packets this is a four-character ASCII string,
411 * called the kiss code, used for debugging and monitoring
412 * in stratum 1 packets this is a four-character ASCII string
413 * assigned to the reference clock by IANA. Example: "GPS "
414 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
415 * of MD5 hash of IPv6
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100416 */
417 uint32_t refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100418 uint8_t ntp_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100419 /* precision is defined as the larger of the resolution and time to
420 * read the clock, in log2 units. For instance, the precision of a
421 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
422 * system clock hardware representation is to the nanosecond.
423 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100424 * Delays, jitters of various kinds are clamped down to precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100425 *
426 * If precision_sec is too large, discipline_jitter gets clamped to it
Denys Vlasenko74584b82012-03-02 01:22:40 +0100427 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
428 * interval grows even though we really can benefit from staying at
429 * smaller one, collecting non-lagged datapoits and correcting offset.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100430 * (Lagged datapoits exist when poll_exp is large but we still have
431 * systematic offset error - the time distance between datapoints
Denys Vlasenko74584b82012-03-02 01:22:40 +0100432 * is significant and older datapoints have smaller offsets.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100433 * This makes our offset estimation a bit smaller than reality)
434 * Due to this effect, setting G_precision_sec close to
435 * STEP_THRESHOLD isn't such a good idea - offsets may grow
436 * too big and we will step. I observed it with -6.
437 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100438 * OTOH, setting precision_sec far too small would result in futile
Denys Vlasenko10ad6222017-04-17 16:13:32 +0200439 * attempts to synchronize to an unachievable precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100440 *
441 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
Denys Vlasenko74584b82012-03-02 01:22:40 +0100442 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
443 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100444 */
Denys Vlasenko74584b82012-03-02 01:22:40 +0100445#define G_precision_exp -9
446 /*
447 * G_precision_exp is used only for construction outgoing packets.
448 * It's ok to set G_precision_sec to a slightly different value
449 * (One which is "nicer looking" in logs).
450 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
451 */
452#define G_precision_sec 0.002
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100453 uint8_t stratum;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100454
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100455#define STATE_NSET 0 /* initial state, "nothing is set" */
456//#define STATE_FSET 1 /* frequency set from file */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +0100457//#define STATE_SPIK 2 /* spike detected */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100458//#define STATE_FREQ 3 /* initial frequency */
459#define STATE_SYNC 4 /* clock synchronized (normal operation) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100460 uint8_t discipline_state; // doc calls it c.state
461 uint8_t poll_exp; // s.poll
462 int polladj_count; // c.count
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +0100463 int FREQHOLD_cnt;
Denys Vlasenko61313112010-01-01 19:56:16 +0100464 long kernel_freq_drift;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100465 peer_t *last_update_peer;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100466 double last_update_offset; // c.last
Denys Vlasenko61313112010-01-01 19:56:16 +0100467 double last_update_recv_time; // s.t
468 double discipline_jitter; // c.jitter
Denys Vlasenko547ee792012-03-05 10:18:00 +0100469 /* Since we only compare it with ints, can simplify code
470 * by not making this variable floating point:
471 */
472 unsigned offset_to_jitter_ratio;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100473 //double cluster_offset; // s.offset
474 //double cluster_jitter; // s.jitter
Denys Vlasenko61313112010-01-01 19:56:16 +0100475#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100476 double discipline_freq_drift; // c.freq
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100477 /* Maybe conditionally calculate wander? it's used only for logging */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100478 double discipline_wander; // c.wander
Denys Vlasenko61313112010-01-01 19:56:16 +0100479#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100480};
481#define G (*ptr_to_globals)
482
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100483
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100484#define VERB1 if (MAX_VERBOSE && G.verbose)
485#define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
486#define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
487#define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
488#define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100489#define VERB6 if (MAX_VERBOSE >= 6 && G.verbose >= 6)
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100490
491
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100492static double LOG2D(int a)
493{
494 if (a < 0)
495 return 1.0 / (1UL << -a);
496 return 1UL << a;
497}
498static ALWAYS_INLINE double SQUARE(double x)
499{
500 return x * x;
501}
502static ALWAYS_INLINE double MAXD(double a, double b)
503{
504 if (a > b)
505 return a;
506 return b;
507}
508static ALWAYS_INLINE double MIND(double a, double b)
509{
510 if (a < b)
511 return a;
512 return b;
513}
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100514static NOINLINE double my_SQRT(double X)
515{
516 union {
517 float f;
518 int32_t i;
519 } v;
520 double invsqrt;
521 double Xhalf = X * 0.5;
522
523 /* Fast and good approximation to 1/sqrt(X), black magic */
524 v.f = X;
525 /*v.i = 0x5f3759df - (v.i >> 1);*/
526 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
527 invsqrt = v.f; /* better than 0.2% accuracy */
528
529 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
530 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
531 * f'(x) = -2/(x*x*x)
532 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
533 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
534 */
535 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
536 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
537 /* With 4 iterations, more than half results will be exact,
538 * at 6th iterations result stabilizes with about 72% results exact.
539 * We are well satisfied with 0.05% accuracy.
540 */
541
542 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
543}
544static ALWAYS_INLINE double SQRT(double X)
545{
546 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
547 if (sizeof(float) != 4)
548 return sqrt(X);
549
Denys Vlasenko2d3253d2010-01-03 21:52:46 +0100550 /* This avoids needing libm, saves about 0.5k on x86-32 */
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100551 return my_SQRT(X);
552}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100553
554static double
555gettime1900d(void)
556{
557 struct timeval tv;
558 gettimeofday(&tv, NULL); /* never fails */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100559 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
560 return G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100561}
562
563static void
564d_to_tv(double d, struct timeval *tv)
565{
566 tv->tv_sec = (long)d;
567 tv->tv_usec = (d - tv->tv_sec) * 1000000;
568}
569
570static double
571lfp_to_d(l_fixedpt_t lfp)
572{
573 double ret;
574 lfp.int_partl = ntohl(lfp.int_partl);
575 lfp.fractionl = ntohl(lfp.fractionl);
576 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
577 return ret;
578}
579static double
580sfp_to_d(s_fixedpt_t sfp)
581{
582 double ret;
583 sfp.int_parts = ntohs(sfp.int_parts);
584 sfp.fractions = ntohs(sfp.fractions);
585 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
586 return ret;
587}
588#if ENABLE_FEATURE_NTPD_SERVER
589static l_fixedpt_t
590d_to_lfp(double d)
591{
592 l_fixedpt_t lfp;
593 lfp.int_partl = (uint32_t)d;
594 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
595 lfp.int_partl = htonl(lfp.int_partl);
596 lfp.fractionl = htonl(lfp.fractionl);
597 return lfp;
598}
599static s_fixedpt_t
600d_to_sfp(double d)
601{
602 s_fixedpt_t sfp;
603 sfp.int_parts = (uint16_t)d;
604 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
605 sfp.int_parts = htons(sfp.int_parts);
606 sfp.fractions = htons(sfp.fractions);
607 return sfp;
608}
609#endif
610
611static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100612dispersion(const datapoint_t *dp)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100613{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100614 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100615}
616
617static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100618root_distance(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100619{
620 /* The root synchronization distance is the maximum error due to
621 * all causes of the local clock relative to the primary server.
622 * It is defined as half the total delay plus total dispersion
623 * plus peer jitter.
624 */
625 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
626 + p->lastpkt_rootdisp
627 + p->filter_dispersion
Denys Vlasenko0b002812010-01-03 08:59:59 +0100628 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100629 + p->filter_jitter;
630}
631
632static void
633set_next(peer_t *p, unsigned t)
634{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100635 p->next_action_time = G.cur_time + t;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100636}
637
638/*
639 * Peer clock filter and its helpers
640 */
641static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100642filter_datapoints(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100643{
644 int i, idx;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100645 double sum, wavg;
646 datapoint_t *fdp;
647
648#if 0
649/* Simulations have shown that use of *averaged* offset for p->filter_offset
650 * is in fact worse than simply using last received one: with large poll intervals
651 * (>= 2048) averaging code uses offset values which are outdated by hours,
652 * and time/frequency correction goes totally wrong when fed essentially bogus offsets.
653 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100654 int got_newest;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100655 double minoff, maxoff, w;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100656 double x = x; /* for compiler */
657 double oldest_off = oldest_off;
658 double oldest_age = oldest_age;
659 double newest_off = newest_off;
660 double newest_age = newest_age;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100661
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100662 fdp = p->filter_datapoint;
663
664 minoff = maxoff = fdp[0].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100665 for (i = 1; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100666 if (minoff > fdp[i].d_offset)
667 minoff = fdp[i].d_offset;
668 if (maxoff < fdp[i].d_offset)
669 maxoff = fdp[i].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100670 }
671
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100672 idx = p->datapoint_idx; /* most recent datapoint's index */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100673 /* Average offset:
674 * Drop two outliers and take weighted average of the rest:
675 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
676 * we use older6/32, not older6/64 since sum of weights should be 1:
677 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
678 */
679 wavg = 0;
680 w = 0.5;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100681 /* n-1
682 * --- dispersion(i)
683 * filter_dispersion = \ -------------
684 * / (i+1)
685 * --- 2
686 * i=0
687 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100688 got_newest = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100689 sum = 0;
690 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100691 VERB5 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100692 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
693 i,
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100694 fdp[idx].d_offset,
695 fdp[idx].d_dispersion, dispersion(&fdp[idx]),
696 G.cur_time - fdp[idx].d_recv_time,
697 (minoff == fdp[idx].d_offset || maxoff == fdp[idx].d_offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100698 ? " (outlier by offset)" : ""
699 );
700 }
701
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100702 sum += dispersion(&fdp[idx]) / (2 << i);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100703
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100704 if (minoff == fdp[idx].d_offset) {
Denys Vlasenkoe4844b82010-01-01 21:59:49 +0100705 minoff -= 1; /* so that we don't match it ever again */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100706 } else
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100707 if (maxoff == fdp[idx].d_offset) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100708 maxoff += 1;
709 } else {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100710 oldest_off = fdp[idx].d_offset;
711 oldest_age = G.cur_time - fdp[idx].d_recv_time;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100712 if (!got_newest) {
713 got_newest = 1;
714 newest_off = oldest_off;
715 newest_age = oldest_age;
716 }
717 x = oldest_off * w;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100718 wavg += x;
719 w /= 2;
720 }
721
722 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
723 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100724 p->filter_dispersion = sum;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100725 wavg += x; /* add another older6/64 to form older6/32 */
726 /* Fix systematic underestimation with large poll intervals.
727 * Imagine that we still have a bit of uncorrected drift,
728 * and poll interval is big (say, 100 sec). Offsets form a progression:
729 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
730 * The algorithm above drops 0.0 and 0.7 as outliers,
731 * and then we have this estimation, ~25% off from 0.7:
732 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
733 */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100734 x = oldest_age - newest_age;
735 if (x != 0) {
736 x = newest_age / x; /* in above example, 100 / (600 - 100) */
737 if (x < 1) { /* paranoia check */
738 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
739 wavg += x;
740 }
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100741 }
742 p->filter_offset = wavg;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100743
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100744#else
745
746 fdp = p->filter_datapoint;
747 idx = p->datapoint_idx; /* most recent datapoint's index */
748
749 /* filter_offset: simply use the most recent value */
750 p->filter_offset = fdp[idx].d_offset;
751
752 /* n-1
753 * --- dispersion(i)
754 * filter_dispersion = \ -------------
755 * / (i+1)
756 * --- 2
757 * i=0
758 */
759 wavg = 0;
760 sum = 0;
761 for (i = 0; i < NUM_DATAPOINTS; i++) {
762 sum += dispersion(&fdp[idx]) / (2 << i);
763 wavg += fdp[idx].d_offset;
764 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
765 }
766 wavg /= NUM_DATAPOINTS;
767 p->filter_dispersion = sum;
768#endif
769
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100770 /* +----- -----+ ^ 1/2
771 * | n-1 |
772 * | --- |
773 * | 1 \ 2 |
774 * filter_jitter = | --- * / (avg-offset_j) |
775 * | n --- |
776 * | j=0 |
777 * +----- -----+
778 * where n is the number of valid datapoints in the filter (n > 1);
779 * if filter_jitter < precision then filter_jitter = precision
780 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100781 sum = 0;
782 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100783 sum += SQUARE(wavg - fdp[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100784 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100785 sum = SQRT(sum / NUM_DATAPOINTS);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100786 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
787
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100788 VERB4 bb_error_msg("filter offset:%+f disp:%f jitter:%f",
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100789 p->filter_offset,
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100790 p->filter_dispersion,
791 p->filter_jitter);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100792}
793
794static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100795reset_peer_stats(peer_t *p, double offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100796{
797 int i;
Denys Vlasenkofc47fce2016-02-10 06:55:07 +0100798 bool small_ofs = fabs(offset) < STEP_THRESHOLD;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100799
Denys Vlasenko777be102013-12-07 17:29:03 +0100800 /* Used to set p->filter_datapoint[i].d_dispersion = MAXDISP
Denys Vlasenko10ad6222017-04-17 16:13:32 +0200801 * and clear reachable bits, but this proved to be too aggressive:
Denys Vlasenkof37f2812016-03-04 07:06:53 +0100802 * after step (tested with suspending laptop for ~30 secs),
Denys Vlasenko777be102013-12-07 17:29:03 +0100803 * this caused all previous data to be considered invalid,
Denys Vlasenko1bfc4b82017-01-19 14:42:34 +0100804 * making us needing to collect full ~8 datapoints per peer
Denys Vlasenko777be102013-12-07 17:29:03 +0100805 * after step in order to start trusting them.
806 * In turn, this was making poll interval decrease even after
807 * step was done. (Poll interval decreases already before step
808 * in this scenario, because we see large offsets and end up with
809 * no good peer to select).
810 */
811
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100812 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100813 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200814 p->filter_datapoint[i].d_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100815 if (p->filter_datapoint[i].d_offset != 0) {
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100816 p->filter_datapoint[i].d_offset -= offset;
817 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
818 // i,
819 // p->filter_datapoint[i].d_offset + offset,
820 // p->filter_datapoint[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100821 }
822 } else {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100823 p->filter_datapoint[i].d_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100824 p->filter_datapoint[i].d_offset = 0;
Denys Vlasenko777be102013-12-07 17:29:03 +0100825 /*p->filter_datapoint[i].d_dispersion = MAXDISP;*/
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100826 }
827 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100828 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200829 p->lastpkt_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100830 } else {
Denys Vlasenko777be102013-12-07 17:29:03 +0100831 /*p->reachable_bits = 0;*/
Denys Vlasenko0b002812010-01-03 08:59:59 +0100832 p->lastpkt_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100833 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100834 filter_datapoints(p); /* recalc p->filter_xxx */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100835 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100836}
837
Natanael Copab62ea342017-01-06 16:18:45 +0100838static len_and_sockaddr*
839resolve_peer_hostname(peer_t *p)
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200840{
Natanael Copab62ea342017-01-06 16:18:45 +0100841 len_and_sockaddr *lsa = host2sockaddr(p->p_hostname, 123);
842 if (lsa) {
843 free(p->p_lsa);
844 free(p->p_dotted);
845 p->p_lsa = lsa;
846 p->p_dotted = xmalloc_sockaddr2dotted_noport(&lsa->u.sa);
Denys Vlasenko1bfc4b82017-01-19 14:42:34 +0100847 VERB1 if (strcmp(p->p_hostname, p->p_dotted) != 0)
848 bb_error_msg("'%s' is %s", p->p_hostname, p->p_dotted);
Denys Vlasenko6a4f2232017-10-31 12:44:37 +0100849 p->dns_errors = 0;
Denys Vlasenkod5c14822017-10-31 16:53:23 +0100850 return lsa;
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200851 }
Denys Vlasenko6a4f2232017-10-31 12:44:37 +0100852 p->dns_errors = ((p->dns_errors << 1) | 1) & DNS_ERRORS_CAP;
Natanael Copab62ea342017-01-06 16:18:45 +0100853 return lsa;
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200854}
855
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200856#if !ENABLE_FEATURE_NTP_AUTH
857#define add_peers(s, key_entry) \
858 add_peers(s)
859#endif
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200860static void
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200861add_peers(const char *s, key_entry_t *key_entry)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100862{
Denys Vlasenkof37f2812016-03-04 07:06:53 +0100863 llist_t *item;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100864 peer_t *p;
865
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +0200866 p = xzalloc(sizeof(*p) + strlen(s));
867 strcpy(p->p_hostname, s);
Natanael Copab62ea342017-01-06 16:18:45 +0100868 p->p_fd = -1;
869 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
870 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
871 reset_peer_stats(p, STEP_THRESHOLD);
Denys Vlasenkof37f2812016-03-04 07:06:53 +0100872
873 /* Names like N.<country2chars>.pool.ntp.org are randomly resolved
874 * to a pool of machines. Sometimes different N's resolve to the same IP.
875 * It is not useful to have two peers with same IP. We skip duplicates.
876 */
Natanael Copab62ea342017-01-06 16:18:45 +0100877 if (resolve_peer_hostname(p)) {
878 for (item = G.ntp_peers; item != NULL; item = item->link) {
879 peer_t *pp = (peer_t *) item->data;
880 if (pp->p_dotted && strcmp(p->p_dotted, pp->p_dotted) == 0) {
881 bb_error_msg("duplicate peer %s (%s)", s, p->p_dotted);
882 free(p->p_lsa);
883 free(p->p_dotted);
884 free(p);
885 return;
886 }
Denys Vlasenkof37f2812016-03-04 07:06:53 +0100887 }
888 }
889
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200890 IF_FEATURE_NTP_AUTH(p->key_entry = key_entry;)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100891 llist_add_to(&G.ntp_peers, p);
892 G.peer_cnt++;
893}
894
895static int
896do_sendto(int fd,
897 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
898 msg_t *msg, ssize_t len)
899{
900 ssize_t ret;
901
902 errno = 0;
903 if (!from) {
904 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
905 } else {
906 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
907 }
908 if (ret != len) {
909 bb_perror_msg("send failed");
910 return -1;
911 }
912 return 0;
913}
914
Brandon P. Enochsa5413142018-10-27 18:55:59 +0200915#if ENABLE_FEATURE_NTP_AUTH
916static void
917hash(key_entry_t *key_entry, const msg_t *msg, uint8_t *output)
918{
919 union {
920 md5_ctx_t m;
921 sha1_ctx_t s;
922 } ctx;
923 unsigned hash_size = sizeof(*msg) - sizeof(msg->m_keyid) - sizeof(msg->m_digest);
924
925 switch (key_entry->type) {
926 case HASH_MD5:
927 md5_begin(&ctx.m);
928 md5_hash(&ctx.m, key_entry->key, key_entry->key_length);
929 md5_hash(&ctx.m, msg, hash_size);
930 md5_end(&ctx.m, output);
931 break;
932 default: /* it's HASH_SHA1 */
933 sha1_begin(&ctx.s);
934 sha1_hash(&ctx.s, key_entry->key, key_entry->key_length);
935 sha1_hash(&ctx.s, msg, hash_size);
936 sha1_end(&ctx.s, output);
937 break;
938 }
939}
940
941static void
942hash_peer(peer_t *p)
943{
944 p->p_xmt_msg.m_keyid = htonl(p->key_entry->id);
945 hash(p->key_entry, &p->p_xmt_msg, p->p_xmt_msg.m_digest);
946}
947
948static int
949hashes_differ(peer_t *p, const msg_t *msg)
950{
951 uint8_t digest[NTP_SHA1_DIGESTSIZE];
952 hash(p->key_entry, msg, digest);
953 return memcmp(digest, msg->m_digest, p->key_entry->msg_size - NTP_MSGSIZE_NOAUTH - KEYID_SIZE);
954}
955#endif
956
Denys Vlasenko0b002812010-01-03 08:59:59 +0100957static void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100958send_query_to_peer(peer_t *p)
959{
Denys Vlasenkoa1e9bc62017-10-28 17:54:24 +0200960 if (!p->p_lsa)
961 return;
Natanael Copab62ea342017-01-06 16:18:45 +0100962
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100963 /* Why do we need to bind()?
964 * See what happens when we don't bind:
965 *
966 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
967 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
968 * gettimeofday({1259071266, 327885}, NULL) = 0
969 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
970 * ^^^ we sent it from some source port picked by kernel.
971 * time(NULL) = 1259071266
972 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
973 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
974 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
975 * ^^^ this recv will receive packets to any local port!
976 *
977 * Uncomment this and use strace to see it in action:
978 */
979#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 +0100980
981 if (p->p_fd == -1) {
982 int fd, family;
983 len_and_sockaddr *local_lsa;
984
985 family = p->p_lsa->u.sa.sa_family;
986 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
987 /* local_lsa has "null" address and port 0 now.
988 * bind() ensures we have a *particular port* selected by kernel
989 * and remembered in p->p_fd, thus later recv(p->p_fd)
990 * receives only packets sent to this port.
991 */
992 PROBE_LOCAL_ADDR
993 xbind(fd, &local_lsa->u.sa, local_lsa->len);
994 PROBE_LOCAL_ADDR
995#if ENABLE_FEATURE_IPV6
996 if (family == AF_INET)
997#endif
Codarren Velvindron7c43d432018-04-15 20:37:50 +0400998 setsockopt_int(fd, IPPROTO_IP, IP_TOS, IPTOS_DSCP_AF21);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100999 free(local_lsa);
1000 }
1001
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01001002 /* Emit message _before_ attempted send. Think of a very short
1003 * roundtrip networks: we need to go back to recv loop ASAP,
1004 * to reduce delay. Printing messages after send works against that.
1005 */
1006 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
1007
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001008 /*
1009 * Send out a random 64-bit number as our transmit time. The NTP
1010 * server will copy said number into the originate field on the
1011 * response that it sends us. This is totally legal per the SNTP spec.
1012 *
1013 * The impact of this is two fold: we no longer send out the current
1014 * system time for the world to see (which may aid an attacker), and
1015 * it gives us a (not very secure) way of knowing that we're not
1016 * getting spoofed by an attacker that can't capture our traffic
1017 * but can spoof packets from the NTP server we're communicating with.
1018 *
1019 * Save the real transmit timestamp locally.
1020 */
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01001021 p->p_xmt_msg.m_xmttime.int_partl = rand();
1022 p->p_xmt_msg.m_xmttime.fractionl = rand();
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001023 p->p_xmttime = gettime1900d();
1024
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02001025 /* Were doing it only if sendto worked, but
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02001026 * loss of sync detection needs reachable_bits updated
1027 * even if sending fails *locally*:
1028 * "network is unreachable" because cable was pulled?
1029 * We still need to declare "unsync" if this condition persists.
1030 */
1031 p->reachable_bits <<= 1;
1032
Brandon P. Enochsa5413142018-10-27 18:55:59 +02001033#if ENABLE_FEATURE_NTP_AUTH
1034 if (p->key_entry)
1035 hash_peer(p);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001036 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
Brandon P. Enochsa5413142018-10-27 18:55:59 +02001037 &p->p_xmt_msg, !p->key_entry ? NTP_MSGSIZE_NOAUTH : p->key_entry->msg_size) == -1
1038 )
1039#else
1040 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
1041 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
1042 )
1043#endif
1044 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001045 close(p->p_fd);
1046 p->p_fd = -1;
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02001047 /*
1048 * We know that we sent nothing.
1049 * We can retry *soon* without fearing
1050 * that we are flooding the peer.
1051 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001052 set_next(p, RETRY_INTERVAL);
Denys Vlasenko0b002812010-01-03 08:59:59 +01001053 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001054 }
1055
Denys Vlasenko0b002812010-01-03 08:59:59 +01001056 set_next(p, RESPONSE_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001057}
1058
1059
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001060/* Note that there is no provision to prevent several run_scripts
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02001061 * to be started in quick succession. In fact, it happens rather often
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001062 * if initial syncronization results in a step.
1063 * You will see "step" and then "stratum" script runs, sometimes
1064 * as close as only 0.002 seconds apart.
1065 * Script should be ready to deal with this.
1066 */
Denys Vlasenko12628b72010-01-11 01:31:59 +01001067static void run_script(const char *action, double offset)
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001068{
1069 char *argv[3];
Denys Vlasenko12628b72010-01-11 01:31:59 +01001070 char *env1, *env2, *env3, *env4;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001071
Denys Vlasenko07c59872013-05-22 18:18:51 +02001072 G.last_script_run = G.cur_time;
1073
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001074 if (!G.script_name)
1075 return;
1076
1077 argv[0] = (char*) G.script_name;
1078 argv[1] = (char*) action;
1079 argv[2] = NULL;
1080
1081 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
1082
Denys Vlasenkoae473352010-01-07 11:51:13 +01001083 env1 = xasprintf("%s=%u", "stratum", G.stratum);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001084 putenv(env1);
Denys Vlasenkoae473352010-01-07 11:51:13 +01001085 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001086 putenv(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +01001087 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
1088 putenv(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001089 env4 = xasprintf("%s=%f", "offset", offset);
1090 putenv(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001091 /* Other items of potential interest: selected peer,
Denys Vlasenkoae473352010-01-07 11:51:13 +01001092 * rootdelay, reftime, rootdisp, refid, ntp_status,
Denys Vlasenko12628b72010-01-11 01:31:59 +01001093 * last_update_offset, last_update_recv_time, discipline_jitter,
1094 * how many peers have reachable_bits = 0?
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001095 */
1096
Denys Vlasenko6959f6b2010-01-07 08:31:46 +01001097 /* Don't want to wait: it may run hwclock --systohc, and that
1098 * may take some time (seconds): */
Denys Vlasenko8531d762010-03-18 22:44:00 +01001099 /*spawn_and_wait(argv);*/
Denys Vlasenko6959f6b2010-01-07 08:31:46 +01001100 spawn(argv);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001101
1102 unsetenv("stratum");
1103 unsetenv("freq_drift_ppm");
Denys Vlasenkoae473352010-01-07 11:51:13 +01001104 unsetenv("poll_interval");
Denys Vlasenko12628b72010-01-11 01:31:59 +01001105 unsetenv("offset");
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001106 free(env1);
1107 free(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +01001108 free(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001109 free(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001110}
1111
Denys Vlasenko0b002812010-01-03 08:59:59 +01001112static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001113step_time(double offset)
1114{
Denys Vlasenko0b002812010-01-03 08:59:59 +01001115 llist_t *item;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001116 double dtime;
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +01001117 struct timeval tvc, tvn;
1118 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001119 time_t tval;
1120
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +01001121 gettimeofday(&tvc, NULL); /* never fails */
1122 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
1123 d_to_tv(dtime, &tvn);
1124 if (settimeofday(&tvn, NULL) == -1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001125 bb_perror_msg_and_die("settimeofday");
1126
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +01001127 VERB2 {
1128 tval = tvc.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +01001129 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +01001130 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
1131 }
1132 tval = tvn.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +01001133 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +01001134 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +01001135 //maybe? G.FREQHOLD_cnt = 0;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001136
1137 /* Correct various fields which contain time-relative values: */
1138
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001139 /* Globals: */
1140 G.cur_time += offset;
1141 G.last_update_recv_time += offset;
1142 G.last_script_run += offset;
1143
Denys Vlasenko0b002812010-01-03 08:59:59 +01001144 /* p->lastpkt_recv_time, p->next_action_time and such: */
1145 for (item = G.ntp_peers; item != NULL; item = item->link) {
1146 peer_t *pp = (peer_t *) item->data;
1147 reset_peer_stats(pp, offset);
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001148 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
Denys Vlasenkoeff6d592010-06-24 20:23:40 +02001149 // offset, pp->next_action_time, pp->next_action_time + offset);
1150 pp->next_action_time += offset;
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001151 if (pp->p_fd >= 0) {
1152 /* We wait for reply from this peer too.
1153 * But due to step we are doing, reply's data is no longer
1154 * useful (in fact, it'll be bogus). Stop waiting for it.
1155 */
1156 close(pp->p_fd);
1157 pp->p_fd = -1;
1158 set_next(pp, RETRY_INTERVAL);
1159 }
Denys Vlasenko0b002812010-01-03 08:59:59 +01001160 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001161}
1162
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001163static void clamp_pollexp_and_set_MAXSTRAT(void)
1164{
1165 if (G.poll_exp < MINPOLL)
1166 G.poll_exp = MINPOLL;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001167 if (G.poll_exp > BIGPOLL)
1168 G.poll_exp = BIGPOLL;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001169 G.polladj_count = 0;
1170 G.stratum = MAXSTRAT;
1171}
1172
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001173
1174/*
1175 * Selection and clustering, and their helpers
1176 */
1177typedef struct {
1178 peer_t *p;
1179 int type;
1180 double edge;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001181 double opt_rd; /* optimization */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001182} point_t;
1183static int
1184compare_point_edge(const void *aa, const void *bb)
1185{
1186 const point_t *a = aa;
1187 const point_t *b = bb;
1188 if (a->edge < b->edge) {
1189 return -1;
1190 }
1191 return (a->edge > b->edge);
1192}
1193typedef struct {
1194 peer_t *p;
1195 double metric;
1196} survivor_t;
1197static int
1198compare_survivor_metric(const void *aa, const void *bb)
1199{
1200 const survivor_t *a = aa;
1201 const survivor_t *b = bb;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001202 if (a->metric < b->metric) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001203 return -1;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001204 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001205 return (a->metric > b->metric);
1206}
1207static int
1208fit(peer_t *p, double rd)
1209{
Denys Vlasenko0b002812010-01-03 08:59:59 +01001210 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
1211 /* One or zero bits in reachable_bits */
Denys Vlasenko13039622018-09-13 12:15:36 +02001212 VERB4 bb_error_msg("peer %s unfit for selection: "
1213 "unreachable", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001214 return 0;
1215 }
Denys Vlasenkofb132e42010-10-29 11:46:52 +02001216#if 0 /* we filter out such packets earlier */
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001217 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001218 || p->lastpkt_stratum >= MAXSTRAT
1219 ) {
Denys Vlasenko13039622018-09-13 12:15:36 +02001220 VERB4 bb_error_msg("peer %s unfit for selection: "
1221 "bad status/stratum", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001222 return 0;
1223 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001224#endif
Denys Vlasenko0b002812010-01-03 08:59:59 +01001225 /* rd is root_distance(p) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001226 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
Denys Vlasenko13039622018-09-13 12:15:36 +02001227 VERB3 bb_error_msg("peer %s unfit for selection: "
1228 "root distance %f too high, jitter:%f",
1229 p->p_dotted, rd, p->filter_jitter
1230 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001231 return 0;
1232 }
1233//TODO
1234// /* Do we have a loop? */
1235// if (p->refid == p->dstaddr || p->refid == s.refid)
1236// return 0;
Denys Vlasenkob7c9fb22011-02-03 00:05:48 +01001237 return 1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001238}
1239static peer_t*
Denys Vlasenko0b002812010-01-03 08:59:59 +01001240select_and_cluster(void)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001241{
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001242 peer_t *p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001243 llist_t *item;
1244 int i, j;
1245 int size = 3 * G.peer_cnt;
1246 /* for selection algorithm */
1247 point_t point[size];
1248 unsigned num_points, num_candidates;
1249 double low, high;
1250 unsigned num_falsetickers;
1251 /* for cluster algorithm */
1252 survivor_t survivor[size];
1253 unsigned num_survivors;
1254
1255 /* Selection */
1256
1257 num_points = 0;
1258 item = G.ntp_peers;
Denys Vlasenkoff3f3ac2015-01-29 16:31:36 +01001259 while (item != NULL) {
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001260 double rd, offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001261
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001262 p = (peer_t *) item->data;
1263 rd = root_distance(p);
1264 offset = p->filter_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001265 if (!fit(p, rd)) {
1266 item = item->link;
1267 continue;
1268 }
1269
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001270 VERB5 bb_error_msg("interval: [%f %f %f] %s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001271 offset - rd,
1272 offset,
1273 offset + rd,
1274 p->p_dotted
1275 );
1276 point[num_points].p = p;
1277 point[num_points].type = -1;
1278 point[num_points].edge = offset - rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001279 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001280 num_points++;
1281 point[num_points].p = p;
1282 point[num_points].type = 0;
1283 point[num_points].edge = offset;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001284 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001285 num_points++;
1286 point[num_points].p = p;
1287 point[num_points].type = 1;
1288 point[num_points].edge = offset + rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001289 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001290 num_points++;
1291 item = item->link;
1292 }
1293 num_candidates = num_points / 3;
1294 if (num_candidates == 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001295 VERB3 bb_error_msg("no valid datapoints%s", ", no peer selected");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001296 return NULL;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001297 }
1298//TODO: sorting does not seem to be done in reference code
1299 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
1300
1301 /* Start with the assumption that there are no falsetickers.
1302 * Attempt to find a nonempty intersection interval containing
1303 * the midpoints of all truechimers.
1304 * If a nonempty interval cannot be found, increase the number
1305 * of assumed falsetickers by one and try again.
1306 * If a nonempty interval is found and the number of falsetickers
1307 * is less than the number of truechimers, a majority has been found
1308 * and the midpoint of each truechimer represents
1309 * the candidates available to the cluster algorithm.
1310 */
1311 num_falsetickers = 0;
1312 while (1) {
1313 int c;
1314 unsigned num_midpoints = 0;
1315
1316 low = 1 << 9;
1317 high = - (1 << 9);
1318 c = 0;
1319 for (i = 0; i < num_points; i++) {
1320 /* We want to do:
1321 * if (point[i].type == -1) c++;
1322 * if (point[i].type == 1) c--;
1323 * and it's simpler to do it this way:
1324 */
1325 c -= point[i].type;
1326 if (c >= num_candidates - num_falsetickers) {
1327 /* If it was c++ and it got big enough... */
1328 low = point[i].edge;
1329 break;
1330 }
1331 if (point[i].type == 0)
1332 num_midpoints++;
1333 }
1334 c = 0;
1335 for (i = num_points-1; i >= 0; i--) {
1336 c += point[i].type;
1337 if (c >= num_candidates - num_falsetickers) {
1338 high = point[i].edge;
1339 break;
1340 }
1341 if (point[i].type == 0)
1342 num_midpoints++;
1343 }
1344 /* If the number of midpoints is greater than the number
1345 * of allowed falsetickers, the intersection contains at
1346 * least one truechimer with no midpoint - bad.
1347 * Also, interval should be nonempty.
1348 */
1349 if (num_midpoints <= num_falsetickers && low < high)
1350 break;
1351 num_falsetickers++;
1352 if (num_falsetickers * 2 >= num_candidates) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001353 VERB3 bb_error_msg("falsetickers:%d, candidates:%d%s",
1354 num_falsetickers, num_candidates,
1355 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001356 return NULL;
1357 }
1358 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001359 VERB4 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001360 low, high, num_candidates, num_falsetickers);
1361
1362 /* Clustering */
1363
1364 /* Construct a list of survivors (p, metric)
1365 * from the chime list, where metric is dominated
1366 * first by stratum and then by root distance.
1367 * All other things being equal, this is the order of preference.
1368 */
1369 num_survivors = 0;
1370 for (i = 0; i < num_points; i++) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001371 if (point[i].edge < low || point[i].edge > high)
1372 continue;
1373 p = point[i].p;
1374 survivor[num_survivors].p = p;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001375 /* x.opt_rd == root_distance(p); */
1376 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001377 VERB5 bb_error_msg("survivor[%d] metric:%f peer:%s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001378 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1379 num_survivors++;
1380 }
1381 /* There must be at least MIN_SELECTED survivors to satisfy the
1382 * correctness assertions. Ordinarily, the Byzantine criteria
1383 * require four survivors, but for the demonstration here, one
1384 * is acceptable.
1385 */
1386 if (num_survivors < MIN_SELECTED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001387 VERB3 bb_error_msg("survivors:%d%s",
1388 num_survivors,
1389 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001390 return NULL;
1391 }
1392
1393//looks like this is ONLY used by the fact that later we pick survivor[0].
1394//we can avoid sorting then, just find the minimum once!
1395 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1396
1397 /* For each association p in turn, calculate the selection
1398 * jitter p->sjitter as the square root of the sum of squares
1399 * (p->offset - q->offset) over all q associations. The idea is
1400 * to repeatedly discard the survivor with maximum selection
1401 * jitter until a termination condition is met.
1402 */
1403 while (1) {
1404 unsigned max_idx = max_idx;
1405 double max_selection_jitter = max_selection_jitter;
1406 double min_jitter = min_jitter;
1407
1408 if (num_survivors <= MIN_CLUSTERED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001409 VERB4 bb_error_msg("num_survivors %d <= %d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001410 num_survivors, MIN_CLUSTERED);
1411 break;
1412 }
1413
1414 /* To make sure a few survivors are left
1415 * for the clustering algorithm to chew on,
1416 * we stop if the number of survivors
1417 * is less than or equal to MIN_CLUSTERED (3).
1418 */
1419 for (i = 0; i < num_survivors; i++) {
1420 double selection_jitter_sq;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001421
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001422 p = survivor[i].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001423 if (i == 0 || p->filter_jitter < min_jitter)
1424 min_jitter = p->filter_jitter;
1425
1426 selection_jitter_sq = 0;
1427 for (j = 0; j < num_survivors; j++) {
1428 peer_t *q = survivor[j].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001429 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1430 }
1431 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1432 max_selection_jitter = selection_jitter_sq;
1433 max_idx = i;
1434 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001435 VERB6 bb_error_msg("survivor %d selection_jitter^2:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001436 i, selection_jitter_sq);
1437 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001438 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001439 VERB5 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001440 max_idx, max_selection_jitter, min_jitter);
1441
1442 /* If the maximum selection jitter is less than the
1443 * minimum peer jitter, then tossing out more survivors
1444 * will not lower the minimum peer jitter, so we might
1445 * as well stop.
1446 */
1447 if (max_selection_jitter < min_jitter) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001448 VERB4 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001449 max_selection_jitter, min_jitter, num_survivors);
1450 break;
1451 }
1452
1453 /* Delete survivor[max_idx] from the list
1454 * and go around again.
1455 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001456 VERB6 bb_error_msg("dropping survivor %d", max_idx);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001457 num_survivors--;
1458 while (max_idx < num_survivors) {
1459 survivor[max_idx] = survivor[max_idx + 1];
1460 max_idx++;
1461 }
1462 }
1463
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001464 if (0) {
1465 /* Combine the offsets of the clustering algorithm survivors
1466 * using a weighted average with weight determined by the root
1467 * distance. Compute the selection jitter as the weighted RMS
1468 * difference between the first survivor and the remaining
1469 * survivors. In some cases the inherent clock jitter can be
1470 * reduced by not using this algorithm, especially when frequent
1471 * clockhopping is involved. bbox: thus we don't do it.
1472 */
1473 double x, y, z, w;
1474 y = z = w = 0;
1475 for (i = 0; i < num_survivors; i++) {
1476 p = survivor[i].p;
1477 x = root_distance(p);
1478 y += 1 / x;
1479 z += p->filter_offset / x;
1480 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1481 }
1482 //G.cluster_offset = z / y;
1483 //G.cluster_jitter = SQRT(w / y);
1484 }
1485
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001486 /* Pick the best clock. If the old system peer is on the list
1487 * and at the same stratum as the first survivor on the list,
1488 * then don't do a clock hop. Otherwise, select the first
1489 * survivor on the list as the new system peer.
1490 */
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001491 p = survivor[0].p;
1492 if (G.last_update_peer
1493 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1494 ) {
1495 /* Starting from 1 is ok here */
1496 for (i = 1; i < num_survivors; i++) {
1497 if (G.last_update_peer == survivor[i].p) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001498 VERB5 bb_error_msg("keeping old synced peer");
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001499 p = G.last_update_peer;
1500 goto keep_old;
1501 }
1502 }
1503 }
1504 G.last_update_peer = p;
1505 keep_old:
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001506 VERB4 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001507 p->p_dotted,
1508 p->filter_offset,
1509 G.cur_time - p->lastpkt_recv_time
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001510 );
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001511 return p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001512}
1513
1514
1515/*
1516 * Local clock discipline and its helpers
1517 */
1518static void
1519set_new_values(int disc_state, double offset, double recv_time)
1520{
1521 /* Enter new state and set state variables. Note we use the time
1522 * of the last clock filter sample, which must be earlier than
1523 * the current time.
1524 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001525 VERB4 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001526 disc_state, offset, recv_time);
1527 G.discipline_state = disc_state;
1528 G.last_update_offset = offset;
1529 G.last_update_recv_time = recv_time;
1530}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001531/* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001532static NOINLINE int
1533update_local_clock(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001534{
1535 int rc;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001536 struct timex tmx;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001537 /* Note: can use G.cluster_offset instead: */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001538 double offset = p->filter_offset;
1539 double recv_time = p->lastpkt_recv_time;
1540 double abs_offset;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001541#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001542 double freq_drift;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001543#endif
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001544#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001545 double since_last_update;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001546#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001547 double etemp, dtemp;
1548
1549 abs_offset = fabs(offset);
1550
Denys Vlasenko12628b72010-01-11 01:31:59 +01001551#if 0
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001552 /* If needed, -S script can do it by looking at $offset
1553 * env var and killing parent */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001554 /* If the offset is too large, give up and go home */
1555 if (abs_offset > PANIC_THRESHOLD) {
1556 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1557 }
Denys Vlasenko12628b72010-01-11 01:31:59 +01001558#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001559
1560 /* If this is an old update, for instance as the result
1561 * of a system peer change, avoid it. We never use
1562 * an old sample or the same sample twice.
1563 */
1564 if (recv_time <= G.last_update_recv_time) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001565 VERB3 bb_error_msg("update from %s: same or older datapoint, not using it",
1566 p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001567 return 0; /* "leave poll interval as is" */
1568 }
1569
1570 /* Clock state machine transition function. This is where the
1571 * action is and defines how the system reacts to large time
1572 * and frequency errors.
1573 */
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001574#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001575 since_last_update = recv_time - G.reftime;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001576#endif
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001577#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001578 freq_drift = 0;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001579#endif
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001580#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001581 if (G.discipline_state == STATE_FREQ) {
1582 /* Ignore updates until the stepout threshold */
1583 if (since_last_update < WATCH_THRESHOLD) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001584 VERB4 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001585 WATCH_THRESHOLD - since_last_update);
1586 return 0; /* "leave poll interval as is" */
1587 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001588# if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001589 freq_drift = (offset - G.last_update_offset) / since_last_update;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001590# endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001591 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001592#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001593
1594 /* There are two main regimes: when the
1595 * offset exceeds the step threshold and when it does not.
1596 */
1597 if (abs_offset > STEP_THRESHOLD) {
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001598#if 0
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001599 double remains;
1600
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001601// This "spike state" seems to be useless, peer selection already drops
1602// occassional "bad" datapoints. If we are here, there were _many_
1603// large offsets. When a few first large offsets are seen,
1604// we end up in "no valid datapoints, no peer selected" state.
1605// Only when enough of them are seen (which means it's not a fluke),
1606// we end up here. Looks like _our_ clock is off.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001607 switch (G.discipline_state) {
1608 case STATE_SYNC:
1609 /* The first outlyer: ignore it, switch to SPIK state */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001610 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1611 p->p_dotted, offset,
1612 "");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001613 G.discipline_state = STATE_SPIK;
1614 return -1; /* "decrease poll interval" */
1615
1616 case STATE_SPIK:
1617 /* Ignore succeeding outlyers until either an inlyer
1618 * is found or the stepout threshold is exceeded.
1619 */
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001620 remains = WATCH_THRESHOLD - since_last_update;
1621 if (remains > 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001622 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1623 p->p_dotted, offset,
1624 ", datapoint ignored");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001625 return -1; /* "decrease poll interval" */
1626 }
1627 /* fall through: we need to step */
1628 } /* switch */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001629#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001630
1631 /* Step the time and clamp down the poll interval.
1632 *
1633 * In NSET state an initial frequency correction is
1634 * not available, usually because the frequency file has
1635 * not yet been written. Since the time is outside the
1636 * capture range, the clock is stepped. The frequency
1637 * will be set directly following the stepout interval.
1638 *
1639 * In FSET state the initial frequency has been set
1640 * from the frequency file. Since the time is outside
1641 * the capture range, the clock is stepped immediately,
1642 * rather than after the stepout interval. Guys get
1643 * nervous if it takes 17 minutes to set the clock for
1644 * the first time.
1645 *
1646 * In SPIK state the stepout threshold has expired and
1647 * the phase is still above the step threshold. Note
1648 * that a single spike greater than the step threshold
1649 * is always suppressed, even at the longer poll
1650 * intervals.
1651 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001652 VERB4 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001653 step_time(offset);
1654 if (option_mask32 & OPT_q) {
1655 /* We were only asked to set time once. Done. */
1656 exit(0);
1657 }
1658
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001659 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001660
Denys Vlasenko12628b72010-01-11 01:31:59 +01001661 run_script("step", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001662
Denys Vlasenkocb761132014-01-08 17:17:52 +01001663 recv_time += offset;
1664
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001665#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001666 if (G.discipline_state == STATE_NSET) {
1667 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1668 return 1; /* "ok to increase poll interval" */
1669 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001670#endif
Denys Vlasenko547ee792012-03-05 10:18:00 +01001671 abs_offset = offset = 0;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001672 set_new_values(STATE_SYNC, offset, recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001673 } else { /* abs_offset <= STEP_THRESHOLD */
1674
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001675 /* The ratio is calculated before jitter is updated to make
1676 * poll adjust code more sensitive to large offsets.
1677 */
1678 G.offset_to_jitter_ratio = abs_offset / G.discipline_jitter;
1679
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001680 /* Compute the clock jitter as the RMS of exponentially
1681 * weighted offset differences. Used by the poll adjust code.
1682 */
1683 etemp = SQUARE(G.discipline_jitter);
Denys Vlasenko74584b82012-03-02 01:22:40 +01001684 dtemp = SQUARE(offset - G.last_update_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001685 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001686 if (G.discipline_jitter < G_precision_sec)
1687 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001688
1689 switch (G.discipline_state) {
1690 case STATE_NSET:
1691 if (option_mask32 & OPT_q) {
1692 /* We were only asked to set time once.
1693 * The clock is precise enough, no need to step.
1694 */
1695 exit(0);
1696 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001697#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001698 /* This is the first update received and the frequency
1699 * has not been initialized. The first thing to do
1700 * is directly measure the oscillator frequency.
1701 */
1702 set_new_values(STATE_FREQ, offset, recv_time);
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001703#else
1704 set_new_values(STATE_SYNC, offset, recv_time);
1705#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001706 VERB4 bb_error_msg("transitioning to FREQ, datapoint ignored");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001707 return 0; /* "leave poll interval as is" */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001708
1709#if 0 /* this is dead code for now */
1710 case STATE_FSET:
1711 /* This is the first update and the frequency
1712 * has been initialized. Adjust the phase, but
1713 * don't adjust the frequency until the next update.
1714 */
1715 set_new_values(STATE_SYNC, offset, recv_time);
1716 /* freq_drift remains 0 */
1717 break;
1718#endif
1719
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001720#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001721 case STATE_FREQ:
1722 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1723 * Correct the phase and frequency and switch to SYNC state.
1724 * freq_drift was already estimated (see code above)
1725 */
1726 set_new_values(STATE_SYNC, offset, recv_time);
1727 break;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001728#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001729
1730 default:
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001731#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001732 /* Compute freq_drift due to PLL and FLL contributions.
1733 *
1734 * The FLL and PLL frequency gain constants
1735 * depend on the poll interval and Allan
1736 * intercept. The FLL is not used below one-half
1737 * the Allan intercept. Above that the loop gain
1738 * increases in steps to 1 / AVG.
1739 */
1740 if ((1 << G.poll_exp) > ALLAN / 2) {
1741 etemp = FLL - G.poll_exp;
1742 if (etemp < AVG)
1743 etemp = AVG;
1744 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1745 }
1746 /* For the PLL the integration interval
1747 * (numerator) is the minimum of the update
1748 * interval and poll interval. This allows
1749 * oversampling, but not undersampling.
1750 */
1751 etemp = MIND(since_last_update, (1 << G.poll_exp));
1752 dtemp = (4 * PLL) << G.poll_exp;
1753 freq_drift += offset * etemp / SQUARE(dtemp);
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001754#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001755 set_new_values(STATE_SYNC, offset, recv_time);
1756 break;
1757 }
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001758 if (G.stratum != p->lastpkt_stratum + 1) {
1759 G.stratum = p->lastpkt_stratum + 1;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001760 run_script("stratum", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001761 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001762 }
1763
Denys Vlasenko0b002812010-01-03 08:59:59 +01001764 G.reftime = G.cur_time;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001765 G.ntp_status = p->lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001766 G.refid = p->lastpkt_refid;
1767 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001768 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
Denys Vlasenko0b002812010-01-03 08:59:59 +01001769 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001770 G.rootdisp = p->lastpkt_rootdisp + dtemp;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001771 VERB4 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001772
1773 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1774 * (Any other state does not reach this, they all return earlier)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001775 * By this time, freq_drift and offset are set
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001776 * to values suitable for adjtimex.
Denys Vlasenko61313112010-01-01 19:56:16 +01001777 */
1778#if !USING_KERNEL_PLL_LOOP
1779 /* Calculate the new frequency drift and frequency stability (wander).
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001780 * Compute the clock wander as the RMS of exponentially weighted
1781 * frequency differences. This is not used directly, but can,
1782 * along with the jitter, be a highly useful monitoring and
1783 * debugging tool.
1784 */
1785 dtemp = G.discipline_freq_drift + freq_drift;
Denys Vlasenko61313112010-01-01 19:56:16 +01001786 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001787 etemp = SQUARE(G.discipline_wander);
1788 dtemp = SQUARE(dtemp);
1789 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1790
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001791 VERB4 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
Denys Vlasenko61313112010-01-01 19:56:16 +01001792 G.discipline_freq_drift,
1793 (long)(G.discipline_freq_drift * 65536e6),
1794 freq_drift,
1795 G.discipline_wander);
1796#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001797 VERB4 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001798 memset(&tmx, 0, sizeof(tmx));
1799 if (adjtimex(&tmx) < 0)
1800 bb_perror_msg_and_die("adjtimex");
Denys Vlasenko8be49c32012-03-06 19:16:50 +01001801 bb_error_msg("p adjtimex freq:%ld offset:%+ld status:0x%x tc:%ld",
1802 tmx.freq, tmx.offset, tmx.status, tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001803 }
1804
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001805 memset(&tmx, 0, sizeof(tmx));
1806#if 0
Denys Vlasenko61313112010-01-01 19:56:16 +01001807//doesn't work, offset remains 0 (!) in kernel:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001808//ntpd: set adjtimex freq:1786097 tmx.offset:77487
1809//ntpd: prev adjtimex freq:1786097 tmx.offset:0
1810//ntpd: cur adjtimex freq:1786097 tmx.offset:0
1811 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1812 /* 65536 is one ppm */
1813 tmx.freq = G.discipline_freq_drift * 65536e6;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001814#endif
1815 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01001816
1817 tmx.offset = (long)(offset * 1000000); /* usec */
1818 if (SLEW_THRESHOLD < STEP_THRESHOLD) {
1819 if (tmx.offset > (long)(SLEW_THRESHOLD * 1000000)) {
1820 tmx.offset = (long)(SLEW_THRESHOLD * 1000000);
1821 }
1822 if (tmx.offset < -(long)(SLEW_THRESHOLD * 1000000)) {
1823 tmx.offset = -(long)(SLEW_THRESHOLD * 1000000);
1824 }
1825 }
1826
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +01001827 tmx.status = STA_PLL;
1828 if (G.FREQHOLD_cnt != 0) {
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +01001829 /* man adjtimex on STA_FREQHOLD:
1830 * "Normally adjustments made via ADJ_OFFSET result in dampened
1831 * frequency adjustments also being made.
1832 * This flag prevents the small frequency adjustment from being
1833 * made when correcting for an ADJ_OFFSET value."
1834 *
1835 * Use this flag for a few first adjustments at the beginning
1836 * of ntpd execution, otherwise even relatively small initial
1837 * offset tend to cause largish changes to in-kernel tmx.freq.
1838 * If ntpd was restarted due to e.g. switch to another network,
1839 * this destroys already well-established tmx.freq value.
1840 */
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01001841 if (G.FREQHOLD_cnt < 0) {
1842 /* Initialize it */
1843// Example: a laptop whose clock runs slower when hibernated,
1844// after wake up it still has good tmx.freq, but accumulated ~0.5 sec offset:
1845// Run with code where initial G.FREQHOLD_cnt was always 8:
1846//15:17:52.947 no valid datapoints, no peer selected
1847//15:17:56.515 update from:<IP> offset:+0.485133 delay:0.157762 jitter:0.209310 clock drift:-1.393ppm tc:4
1848//15:17:57.719 update from:<IP> offset:+0.483825 delay:0.158070 jitter:0.181159 clock drift:-1.393ppm tc:4
1849//15:17:59.925 update from:<IP> offset:+0.479504 delay:0.158147 jitter:0.156657 clock drift:-1.393ppm tc:4
1850//15:18:33.322 update from:<IP> offset:+0.428119 delay:0.158317 jitter:0.138071 clock drift:-1.393ppm tc:4
1851//15:19:06.718 update from:<IP> offset:+0.376932 delay:0.158276 jitter:0.122075 clock drift:-1.393ppm tc:4
1852//15:19:39.114 update from:<IP> offset:+0.327022 delay:0.158384 jitter:0.108538 clock drift:-1.393ppm tc:4
1853//15:20:12.715 update from:<IP> offset:+0.275596 delay:0.158297 jitter:0.097292 clock drift:-1.393ppm tc:4
1854//15:20:45.111 update from:<IP> offset:+0.225715 delay:0.158271 jitter:0.087841 clock drift:-1.393ppm tc:4
Denys Vlasenko029bd182018-07-02 16:17:07 +02001855// If allowed to continue, it would start increasing tmx.freq now.
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01001856// Instead, it was ^Ced, and started anew:
1857//15:21:15.043 no valid datapoints, no peer selected
1858//15:21:17.408 update from:<IP> offset:+0.175910 delay:0.158314 jitter:0.076683 clock drift:-1.393ppm tc:4
1859//15:21:19.774 update from:<IP> offset:+0.171784 delay:0.158401 jitter:0.066436 clock drift:-1.393ppm tc:4
1860//15:21:22.140 update from:<IP> offset:+0.171660 delay:0.158592 jitter:0.057536 clock drift:-1.393ppm tc:4
1861//15:21:22.140 update from:<IP> offset:+0.167126 delay:0.158507 jitter:0.049792 clock drift:-1.393ppm tc:4
1862//15:21:55.696 update from:<IP> offset:+0.115223 delay:0.158277 jitter:0.050240 clock drift:-1.393ppm tc:4
1863//15:22:29.093 update from:<IP> offset:+0.068051 delay:0.158243 jitter:0.049405 clock drift:-1.393ppm tc:5
1864//15:23:02.490 update from:<IP> offset:+0.051632 delay:0.158215 jitter:0.043545 clock drift:-1.393ppm tc:5
1865//15:23:34.726 update from:<IP> offset:+0.039984 delay:0.158157 jitter:0.038106 clock drift:-1.393ppm tc:5
1866// STA_FREQHOLD no longer set, started increasing tmx.freq now:
1867//15:24:06.961 update from:<IP> offset:+0.030968 delay:0.158190 jitter:0.033306 clock drift:+2.387ppm tc:5
1868//15:24:40.357 update from:<IP> offset:+0.023648 delay:0.158211 jitter:0.029072 clock drift:+5.454ppm tc:5
1869//15:25:13.774 update from:<IP> offset:+0.018068 delay:0.157660 jitter:0.025288 clock drift:+7.728ppm tc:5
1870//15:26:19.173 update from:<IP> offset:+0.010057 delay:0.157969 jitter:0.022255 clock drift:+8.361ppm tc:6
1871//15:27:26.602 update from:<IP> offset:+0.006737 delay:0.158103 jitter:0.019316 clock drift:+8.792ppm tc:6
1872//15:28:33.030 update from:<IP> offset:+0.004513 delay:0.158294 jitter:0.016765 clock drift:+9.080ppm tc:6
1873//15:29:40.617 update from:<IP> offset:+0.002787 delay:0.157745 jitter:0.014543 clock drift:+9.258ppm tc:6
1874//15:30:47.045 update from:<IP> offset:+0.001324 delay:0.157709 jitter:0.012594 clock drift:+9.342ppm tc:6
1875//15:31:53.473 update from:<IP> offset:+0.000007 delay:0.158142 jitter:0.010922 clock drift:+9.343ppm tc:6
1876//15:32:58.902 update from:<IP> offset:-0.000728 delay:0.158222 jitter:0.009454 clock drift:+9.298ppm tc:6
1877 /*
Denys Vlasenko79153cb2018-07-25 14:58:49 +02001878 * This expression would choose MIN_FREQHOLD + 8 in the above example.
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01001879 */
Denys Vlasenko79153cb2018-07-25 14:58:49 +02001880 G.FREQHOLD_cnt = 1 + MIN_FREQHOLD + ((unsigned)(abs(tmx.offset)) >> 16);
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01001881 }
1882 G.FREQHOLD_cnt--;
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +01001883 tmx.status |= STA_FREQHOLD;
1884 }
1885 if (G.ntp_status & LI_PLUSSEC)
1886 tmx.status |= STA_INS;
1887 if (G.ntp_status & LI_MINUSSEC)
1888 tmx.status |= STA_DEL;
1889
Denys Vlasenkofc47fce2016-02-10 06:55:07 +01001890 tmx.constant = (int)G.poll_exp - 4;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001891 /* EXPERIMENTAL.
1892 * The below if statement should be unnecessary, but...
1893 * It looks like Linux kernel's PLL is far too gentle in changing
1894 * tmx.freq in response to clock offset. Offset keeps growing
1895 * and eventually we fall back to smaller poll intervals.
Denys Vlasenko10ad6222017-04-17 16:13:32 +02001896 * We can make correction more aggressive (about x2) by supplying
Denys Vlasenko132b0442012-03-05 00:51:48 +01001897 * PLL time constant which is one less than the real one.
1898 * To be on a safe side, let's do it only if offset is significantly
1899 * larger than jitter.
1900 */
Denys Vlasenkofc47fce2016-02-10 06:55:07 +01001901 if (G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001902 tmx.constant--;
Denys Vlasenko39dfb4d2018-03-10 21:25:53 +01001903 if (tmx.constant < 0)
1904 tmx.constant = 0;
1905
Denys Vlasenko132b0442012-03-05 00:51:48 +01001906 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1907 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001908 rc = adjtimex(&tmx);
1909 if (rc < 0)
1910 bb_perror_msg_and_die("adjtimex");
Denys Vlasenkod9109e32010-01-02 00:36:43 +01001911 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1912 * Not sure why. Perhaps it is normal.
1913 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001914 VERB4 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001915 rc, tmx.freq, tmx.offset, tmx.status);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001916 G.kernel_freq_drift = tmx.freq / 65536;
Denys Vlasenko03718bb2016-02-24 01:22:45 +01001917 VERB2 bb_error_msg("update from:%s offset:%+f delay:%f jitter:%f clock drift:%+.3fppm tc:%d",
1918 p->p_dotted,
1919 offset,
Denys Vlasenko9b1c8bf2018-08-03 11:03:55 +02001920 p->p_raw_delay,
Denys Vlasenko03718bb2016-02-24 01:22:45 +01001921 G.discipline_jitter,
1922 (double)tmx.freq / 65536,
1923 (int)tmx.constant
1924 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001925
1926 return 1; /* "ok to increase poll interval" */
1927}
1928
1929
1930/*
1931 * We've got a new reply packet from a peer, process it
1932 * (helpers first)
1933 */
1934static unsigned
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001935poll_interval(int upper_bound)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001936{
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001937 unsigned interval, r, mask;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001938 interval = 1 << G.poll_exp;
1939 if (interval > upper_bound)
1940 interval = upper_bound;
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001941 mask = ((interval-1) >> 4) | 1;
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01001942 r = rand();
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001943 interval += r & mask; /* ~ random(0..1) * interval/16 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001944 VERB4 bb_error_msg("chose poll interval:%u (poll_exp:%d)", interval, G.poll_exp);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001945 return interval;
1946}
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001947static void
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001948adjust_poll(int count)
1949{
1950 G.polladj_count += count;
1951 if (G.polladj_count > POLLADJ_LIMIT) {
1952 G.polladj_count = 0;
1953 if (G.poll_exp < MAXPOLL) {
1954 G.poll_exp++;
1955 VERB4 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1956 G.discipline_jitter, G.poll_exp);
1957 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001958 } else if (G.polladj_count < -POLLADJ_LIMIT || (count < 0 && G.poll_exp > BIGPOLL)) {
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001959 G.polladj_count = 0;
1960 if (G.poll_exp > MINPOLL) {
1961 llist_t *item;
1962
1963 G.poll_exp--;
1964 /* Correct p->next_action_time in each peer
1965 * which waits for sending, so that they send earlier.
1966 * Old pp->next_action_time are on the order
1967 * of t + (1 << old_poll_exp) + small_random,
1968 * we simply need to subtract ~half of that.
1969 */
1970 for (item = G.ntp_peers; item != NULL; item = item->link) {
1971 peer_t *pp = (peer_t *) item->data;
1972 if (pp->p_fd < 0)
1973 pp->next_action_time -= (1 << G.poll_exp);
1974 }
1975 VERB4 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1976 G.discipline_jitter, G.poll_exp);
1977 }
1978 } else {
1979 VERB4 bb_error_msg("polladj: count:%d", G.polladj_count);
1980 }
1981}
1982static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001983recv_and_process_peer_pkt(peer_t *p)
1984{
1985 int rc;
1986 ssize_t size;
1987 msg_t msg;
1988 double T1, T2, T3, T4;
Denys Vlasenkod531f932014-04-19 19:00:16 +02001989 double offset;
1990 double prev_delay, delay;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001991 unsigned interval;
1992 datapoint_t *datapoint;
1993 peer_t *q;
1994
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001995 offset = 0;
1996
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001997 /* We can recvfrom here and check from.IP, but some multihomed
1998 * ntp servers reply from their *other IP*.
1999 * TODO: maybe we should check at least what we can: from.port == 123?
2000 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002001 recv_again:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002002 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002003 if (size < 0) {
2004 if (errno == EINTR)
2005 /* Signal caught */
2006 goto recv_again;
2007 if (errno == EAGAIN)
2008 /* There was no packet after all
2009 * (poll() returning POLLIN for a fd
2010 * is not a ironclad guarantee that data is there)
2011 */
2012 return;
2013 /*
2014 * If you need a different handling for a specific
2015 * errno, always explain it in comment.
2016 */
2017 bb_perror_msg_and_die("recv(%s) error", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002018 }
2019
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002020#if ENABLE_FEATURE_NTP_AUTH
2021 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE_MD5_AUTH && size != NTP_MSGSIZE_SHA1_AUTH) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002022 bb_error_msg("malformed packet received from %s", p->p_dotted);
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02002023 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002024 }
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002025 if (p->key_entry && hashes_differ(p, &msg)) {
2026 bb_error_msg("invalid cryptographic hash received from %s", p->p_dotted);
2027 return;
2028 }
2029#else
2030 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE_MD5_AUTH) {
2031 bb_error_msg("malformed packet received from %s", p->p_dotted);
2032 return;
2033 }
2034#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002035
2036 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
2037 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
2038 ) {
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02002039 /* Somebody else's packet */
2040 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002041 }
2042
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02002043 /* We do not expect any more packets from this peer for now.
2044 * Closing the socket informs kernel about it.
2045 * We open a new socket when we send a new query.
2046 */
2047 close(p->p_fd);
2048 p->p_fd = -1;
2049
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002050 if ((msg.m_status & LI_ALARM) == LI_ALARM
2051 || msg.m_stratum == 0
2052 || msg.m_stratum > NTP_MAXSTRATUM
2053 ) {
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002054 bb_error_msg("reply from %s: peer is unsynced", p->p_dotted);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002055 /*
2056 * Stratum 0 responses may have commands in 32-bit m_refid field:
2057 * "DENY", "RSTR" - peer does not like us at all,
2058 * "RATE" - peer is overloaded, reduce polling freq.
2059 * If poll interval is small, increase it.
2060 */
2061 if (G.poll_exp < BIGPOLL)
2062 goto increase_interval;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002063 goto pick_normal_interval;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002064 }
2065
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002066// /* Verify valid root distance */
2067// if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
2068// return; /* invalid header values */
2069
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002070 /*
2071 * From RFC 2030 (with a correction to the delay math):
2072 *
2073 * Timestamp Name ID When Generated
2074 * ------------------------------------------------------------
2075 * Originate Timestamp T1 time request sent by client
2076 * Receive Timestamp T2 time request received by server
2077 * Transmit Timestamp T3 time reply sent by server
2078 * Destination Timestamp T4 time reply received by client
2079 *
2080 * The roundtrip delay and local clock offset are defined as
2081 *
2082 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
2083 */
2084 T1 = p->p_xmttime;
2085 T2 = lfp_to_d(msg.m_rectime);
2086 T3 = lfp_to_d(msg.m_xmttime);
Denys Vlasenko0b002812010-01-03 08:59:59 +01002087 T4 = G.cur_time;
Denys Vlasenko9b1c8bf2018-08-03 11:03:55 +02002088 delay = (T4 - T1) - (T3 - T2);
2089
2090 /*
2091 * If this packet's delay is much bigger than the last one,
2092 * it's better to just ignore it than use its much less precise value.
2093 */
2094 prev_delay = p->p_raw_delay;
2095 p->p_raw_delay = (delay < 0 ? 0.0 : delay);
2096 if (p->reachable_bits
2097 && delay > prev_delay * BAD_DELAY_GROWTH
2098 && delay > 1.0 / (8 * 1024) /* larger than ~0.000122 */
2099 ) {
2100 bb_error_msg("reply from %s: delay %f is too high, ignoring", p->p_dotted, delay);
2101 goto pick_normal_interval;
2102 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002103
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002104 /* The delay calculation is a special case. In cases where the
2105 * server and client clocks are running at different rates and
2106 * with very fast networks, the delay can appear negative. In
2107 * order to avoid violating the Principle of Least Astonishment,
2108 * the delay is clamped not less than the system precision.
2109 */
Denys Vlasenkod531f932014-04-19 19:00:16 +02002110 if (delay < G_precision_sec)
2111 delay = G_precision_sec;
Denys Vlasenkod531f932014-04-19 19:00:16 +02002112 p->lastpkt_delay = delay;
2113 p->lastpkt_recv_time = T4;
2114 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
2115 p->lastpkt_status = msg.m_status;
2116 p->lastpkt_stratum = msg.m_stratum;
2117 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
2118 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
2119 p->lastpkt_refid = msg.m_refid;
2120
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002121 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
2122 datapoint = &p->filter_datapoint[p->datapoint_idx];
2123 datapoint->d_recv_time = T4;
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01002124 datapoint->d_offset = offset = ((T2 - T1) + (T3 - T4)) / 2;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002125 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002126 if (!p->reachable_bits) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002127 /* 1st datapoint ever - replicate offset in every element */
2128 int i;
Denys Vlasenko132b0442012-03-05 00:51:48 +01002129 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01002130 p->filter_datapoint[i].d_offset = offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002131 }
2132 }
2133
Denys Vlasenko0b002812010-01-03 08:59:59 +01002134 p->reachable_bits |= 1;
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01002135 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
Denys Vlasenko79bec062012-03-08 13:02:52 +01002136 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 +01002137 p->p_dotted,
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01002138 offset,
Denys Vlasenko9b1c8bf2018-08-03 11:03:55 +02002139 p->p_raw_delay,
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002140 p->lastpkt_status,
2141 p->lastpkt_stratum,
2142 p->lastpkt_refid,
Denys Vlasenkod98dc922012-03-08 03:27:49 +01002143 p->lastpkt_rootdelay,
2144 p->reachable_bits
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002145 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
2146 * m_reftime, m_orgtime, m_rectime, m_xmttime
2147 */
2148 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002149 }
2150
2151 /* Muck with statictics and update the clock */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002152 filter_datapoints(p);
2153 q = select_and_cluster();
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002154 rc = 0;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002155 if (q) {
Denys Vlasenko12628b72010-01-11 01:31:59 +01002156 if (!(option_mask32 & OPT_w)) {
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002157 rc = update_local_clock(q);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002158#if 0
2159//Disabled this because there is a case where largish offsets
2160//are unavoidable: if network round-trip delay is, say, ~0.6s,
2161//error in offset estimation would be ~delay/2 ~= 0.3s.
2162//Thus, offsets will be usually in -0.3...0.3s range.
2163//In this case, this code would keep poll interval small,
2164//but it won't be helping.
2165//BIGOFF check below deals with a case of seeing multi-second offsets.
2166
Denys Vlasenko12628b72010-01-11 01:31:59 +01002167 /* If drift is dangerously large, immediately
2168 * drop poll interval one step down.
2169 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01002170 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01002171 VERB4 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02002172 adjust_poll(-POLLADJ_LIMIT * 3);
2173 rc = 0;
Denys Vlasenko12628b72010-01-11 01:31:59 +01002174 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002175#endif
Denys Vlasenko12628b72010-01-11 01:31:59 +01002176 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002177 } else {
2178 /* No peer selected.
2179 * If poll interval is small, increase it.
2180 */
2181 if (G.poll_exp < BIGPOLL)
2182 goto increase_interval;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002183 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002184
2185 if (rc != 0) {
2186 /* Adjust the poll interval by comparing the current offset
2187 * with the clock jitter. If the offset is less than
2188 * the clock jitter times a constant, then the averaging interval
2189 * is increased, otherwise it is decreased. A bit of hysteresis
2190 * helps calm the dance. Works best using burst mode.
2191 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01002192 if (rc > 0 && G.offset_to_jitter_ratio <= POLLADJ_GATE) {
Denys Vlasenkobfc2a322010-01-01 18:12:06 +01002193 /* was += G.poll_exp but it is a bit
2194 * too optimistic for my taste at high poll_exp's */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002195 increase_interval:
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02002196 adjust_poll(MINPOLL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002197 } else {
Denys Vlasenkofc47fce2016-02-10 06:55:07 +01002198 VERB3 if (rc > 0)
Denys Vlasenko4c48a642016-03-03 22:01:23 +01002199 bb_error_msg("want smaller interval: offset/jitter = %u",
2200 G.offset_to_jitter_ratio);
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02002201 adjust_poll(-G.poll_exp * 2);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002202 }
2203 }
2204
2205 /* Decide when to send new query for this peer */
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002206 pick_normal_interval:
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002207 interval = poll_interval(INT_MAX);
2208 if (fabs(offset) >= BIGOFF && interval > BIGOFF_INTERVAL) {
Denys Vlasenkofc47fce2016-02-10 06:55:07 +01002209 /* If we are synced, offsets are less than SLEW_THRESHOLD,
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01002210 * or at the very least not much larger than it.
2211 * Now we see a largish one.
2212 * Either this peer is feeling bad, or packet got corrupted,
2213 * or _our_ clock is wrong now and _all_ peers will show similar
2214 * largish offsets too.
2215 * I observed this with laptop suspend stopping clock.
2216 * In any case, it makes sense to make next request soonish:
2217 * cases 1 and 2: get a better datapoint,
2218 * case 3: allows to resync faster.
2219 */
2220 interval = BIGOFF_INTERVAL;
2221 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002222
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01002223 set_next(p, interval);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002224}
2225
2226#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01002227static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002228recv_and_process_client_pkt(void /*int fd*/)
2229{
2230 ssize_t size;
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02002231 //uint8_t version;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002232 len_and_sockaddr *to;
2233 struct sockaddr *from;
2234 msg_t msg;
2235 uint8_t query_status;
2236 l_fixedpt_t query_xmttime;
2237
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002238 to = get_sock_lsa(G_listen_fd);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002239 from = xzalloc(to->len);
2240
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002241 size = recv_from_to(G_listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002242#if ENABLE_FEATURE_NTP_AUTH
2243 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE_MD5_AUTH && size != NTP_MSGSIZE_SHA1_AUTH)
2244#else
2245 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE_MD5_AUTH)
2246#endif
2247 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002248 char *addr;
2249 if (size < 0) {
2250 if (errno == EAGAIN)
2251 goto bail;
2252 bb_perror_msg_and_die("recv");
2253 }
2254 addr = xmalloc_sockaddr2dotted_noport(from);
2255 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
2256 free(addr);
2257 goto bail;
2258 }
2259
Miroslav Lichvar150dc7a2016-08-01 20:24:24 +02002260 /* Respond only to client and symmetric active packets */
2261 if ((msg.m_status & MODE_MASK) != MODE_CLIENT
2262 && (msg.m_status & MODE_MASK) != MODE_SYM_ACT
2263 ) {
2264 goto bail;
2265 }
2266
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002267 query_status = msg.m_status;
2268 query_xmttime = msg.m_xmttime;
2269
2270 /* Build a reply packet */
2271 memset(&msg, 0, sizeof(msg));
Paul Marksb7841cf2013-01-14 02:39:10 +01002272 msg.m_status = G.stratum < MAXSTRAT ? (G.ntp_status & LI_MASK) : LI_ALARM;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002273 msg.m_status |= (query_status & VERSION_MASK);
2274 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
Denys Vlasenko69675782013-01-14 01:34:48 +01002275 MODE_SERVER : MODE_SYM_PAS;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002276 msg.m_stratum = G.stratum;
2277 msg.m_ppoll = G.poll_exp;
2278 msg.m_precision_exp = G_precision_exp;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002279 /* this time was obtained between poll() and recv() */
2280 msg.m_rectime = d_to_lfp(G.cur_time);
2281 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
Denys Vlasenkod6782572010-10-04 01:20:44 +02002282 if (G.peer_cnt == 0) {
2283 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
2284 G.reftime = G.cur_time;
2285 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002286 msg.m_reftime = d_to_lfp(G.reftime);
2287 msg.m_orgtime = query_xmttime;
2288 msg.m_rootdelay = d_to_sfp(G.rootdelay);
2289//simple code does not do this, fix simple code!
2290 msg.m_rootdisp = d_to_sfp(G.rootdisp);
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02002291 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002292 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
2293
2294 /* We reply from the local address packet was sent to,
2295 * this makes to/from look swapped here: */
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002296 do_sendto(G_listen_fd,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002297 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
2298 &msg, size);
2299
2300 bail:
2301 free(to);
2302 free(from);
2303}
2304#endif
2305
2306/* Upstream ntpd's options:
2307 *
2308 * -4 Force DNS resolution of host names to the IPv4 namespace.
2309 * -6 Force DNS resolution of host names to the IPv6 namespace.
2310 * -a Require cryptographic authentication for broadcast client,
2311 * multicast client and symmetric passive associations.
2312 * This is the default.
2313 * -A Do not require cryptographic authentication for broadcast client,
2314 * multicast client and symmetric passive associations.
2315 * This is almost never a good idea.
2316 * -b Enable the client to synchronize to broadcast servers.
2317 * -c conffile
2318 * Specify the name and path of the configuration file,
2319 * default /etc/ntp.conf
2320 * -d Specify debugging mode. This option may occur more than once,
2321 * with each occurrence indicating greater detail of display.
2322 * -D level
2323 * Specify debugging level directly.
2324 * -f driftfile
2325 * Specify the name and path of the frequency file.
2326 * This is the same operation as the "driftfile FILE"
2327 * configuration command.
2328 * -g Normally, ntpd exits with a message to the system log
2329 * if the offset exceeds the panic threshold, which is 1000 s
2330 * by default. This option allows the time to be set to any value
2331 * without restriction; however, this can happen only once.
2332 * If the threshold is exceeded after that, ntpd will exit
2333 * with a message to the system log. This option can be used
2334 * with the -q and -x options. See the tinker command for other options.
2335 * -i jaildir
2336 * Chroot the server to the directory jaildir. This option also implies
2337 * that the server attempts to drop root privileges at startup
2338 * (otherwise, chroot gives very little additional security).
2339 * You may need to also specify a -u option.
2340 * -k keyfile
2341 * Specify the name and path of the symmetric key file,
2342 * default /etc/ntp/keys. This is the same operation
2343 * as the "keys FILE" configuration command.
2344 * -l logfile
2345 * Specify the name and path of the log file. The default
2346 * is the system log file. This is the same operation as
2347 * the "logfile FILE" configuration command.
2348 * -L Do not listen to virtual IPs. The default is to listen.
2349 * -n Don't fork.
2350 * -N To the extent permitted by the operating system,
2351 * run the ntpd at the highest priority.
2352 * -p pidfile
2353 * Specify the name and path of the file used to record the ntpd
2354 * process ID. This is the same operation as the "pidfile FILE"
2355 * configuration command.
2356 * -P priority
2357 * To the extent permitted by the operating system,
2358 * run the ntpd at the specified priority.
2359 * -q Exit the ntpd just after the first time the clock is set.
2360 * This behavior mimics that of the ntpdate program, which is
2361 * to be retired. The -g and -x options can be used with this option.
2362 * Note: The kernel time discipline is disabled with this option.
2363 * -r broadcastdelay
2364 * Specify the default propagation delay from the broadcast/multicast
2365 * server to this client. This is necessary only if the delay
2366 * cannot be computed automatically by the protocol.
2367 * -s statsdir
2368 * Specify the directory path for files created by the statistics
2369 * facility. This is the same operation as the "statsdir DIR"
2370 * configuration command.
2371 * -t key
2372 * Add a key number to the trusted key list. This option can occur
2373 * more than once.
2374 * -u user[:group]
2375 * Specify a user, and optionally a group, to switch to.
2376 * -v variable
2377 * -V variable
2378 * Add a system variable listed by default.
2379 * -x Normally, the time is slewed if the offset is less than the step
2380 * threshold, which is 128 ms by default, and stepped if above
2381 * the threshold. This option sets the threshold to 600 s, which is
2382 * well within the accuracy window to set the clock manually.
2383 * Note: since the slew rate of typical Unix kernels is limited
2384 * to 0.5 ms/s, each second of adjustment requires an amortization
2385 * interval of 2000 s. Thus, an adjustment as much as 600 s
2386 * will take almost 14 days to complete. This option can be used
2387 * with the -g and -q options. See the tinker command for other options.
2388 * Note: The kernel time discipline is disabled with this option.
2389 */
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002390#if ENABLE_FEATURE_NTP_AUTH
2391static key_entry_t *
2392find_key_entry(llist_t *key_entries, unsigned id)
2393{
2394 while (key_entries) {
2395 key_entry_t *cur = (key_entry_t*) key_entries->data;
2396 if (cur->id == id)
2397 return cur;
2398 key_entries = key_entries->link;
2399 }
2400 bb_error_msg_and_die("key %u is not defined", id);
2401}
2402#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002403
2404/* By doing init in a separate function we decrease stack usage
2405 * in main loop.
2406 */
2407static NOINLINE void ntp_init(char **argv)
2408{
2409 unsigned opts;
2410 llist_t *peers;
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002411#if ENABLE_FEATURE_NTP_AUTH
2412 llist_t *key_entries;
2413 char *key_file_path;
2414#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002415
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01002416 srand(getpid());
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002417
2418 if (getuid())
2419 bb_error_msg_and_die(bb_msg_you_must_be_root);
2420
2421 /* Set some globals */
Miroslav Lichvar760d0352014-10-05 03:10:15 +02002422 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002423 G.stratum = MAXSTRAT;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002424 if (BURSTPOLL != 0)
2425 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002426 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
Denys Vlasenko448fdcc2018-03-11 17:08:02 +01002427 G.FREQHOLD_cnt = -1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002428
2429 /* Parse options */
2430 peers = NULL;
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002431 IF_FEATURE_NTP_AUTH(key_entries = NULL;)
Denys Vlasenko22542ec2017-08-08 21:55:02 +02002432 opts = getopt32(argv, "^"
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002433 "nqNx" /* compat */
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002434 IF_FEATURE_NTP_AUTH("k:") /* compat */
Denys Vlasenko237bedd2016-07-06 21:58:02 +02002435 "wp:*S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
Denys Vlasenko278842d2014-07-15 15:06:54 +02002436 IF_FEATURE_NTPD_SERVER("I:") /* compat */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002437 "d" /* compat */
Denys Vlasenko8b77a9e2017-08-23 15:08:25 +02002438 "46aAbgL" /* compat, ignored */
Denys Vlasenko22542ec2017-08-08 21:55:02 +02002439 "\0"
2440 "dd:wn" /* -d: counter; -p: list; -w implies -n */
2441 IF_FEATURE_NTPD_SERVER(":Il") /* -I implies -l */
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002442 IF_FEATURE_NTP_AUTH(, &key_file_path)
2443 , &peers, &G.script_name
2444 IF_FEATURE_NTPD_SERVER(, &G.if_name)
2445 , &G.verbose
2446 );
Denys Vlasenko504fe452014-03-23 15:06:38 +01002447
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002448// if (opts & OPT_x) /* disable stepping, only slew is allowed */
2449// G.time_was_stepped = 1;
Denys Vlasenkoaabb0a92016-07-03 17:58:54 +02002450
2451#if ENABLE_FEATURE_NTPD_SERVER
2452 G_listen_fd = -1;
2453 if (opts & OPT_l) {
2454 G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
2455 if (G.if_name) {
2456 if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
2457 xfunc_die();
2458 }
2459 socket_want_pktinfo(G_listen_fd);
Codarren Velvindron7c43d432018-04-15 20:37:50 +04002460 setsockopt_int(G_listen_fd, IPPROTO_IP, IP_TOS, IPTOS_DSCP_AF21);
Denys Vlasenkoaabb0a92016-07-03 17:58:54 +02002461 }
2462#endif
2463 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
2464 if (opts & OPT_N)
2465 setpriority(PRIO_PROCESS, 0, -15);
2466
Denys Vlasenkoaabb0a92016-07-03 17:58:54 +02002467 if (!(opts & OPT_n)) {
2468 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
2469 logmode = LOGMODE_NONE;
2470 }
2471
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002472#if ENABLE_FEATURE_NTP_AUTH
2473 if (opts & OPT_k) {
2474 char *tokens[4];
2475 parser_t *parser;
2476
2477 parser = config_open(key_file_path);
2478 while (config_read(parser, tokens, 4, 3, "# \t", PARSE_NORMAL | PARSE_MIN_DIE) == 3) {
2479 key_entry_t *key_entry;
2480 char buffer[40];
2481 smalluint hash_type;
2482 smalluint msg_size;
2483 smalluint key_length;
2484 char *key;
2485
2486 if ((tokens[1][0] | 0x20) == 'm')
2487 /* supports 'M' and 'md5' formats */
2488 hash_type = HASH_MD5;
2489 else
2490 if (strncasecmp(tokens[1], "sha", 3) == 0)
2491 /* supports 'sha' and 'sha1' formats */
2492 hash_type = HASH_SHA1;
2493 else
2494 bb_error_msg_and_die("only MD5 and SHA1 keys supported");
2495/* man ntp.keys:
2496 * MD5 The key is 1 to 16 printable characters terminated by an EOL,
2497 * whitespace, or a # (which is the "start of comment" character).
2498 * SHA
2499 * SHA1
2500 * RMD160 The key is a hex-encoded ASCII string of 40 characters, which
2501 * is truncated as necessary.
2502 */
2503 key_length = strnlen(tokens[2], sizeof(buffer)+1);
2504 if (key_length >= sizeof(buffer)+1) {
2505 err:
2506 bb_error_msg_and_die("malformed key at line %u", parser->lineno);
2507 }
2508 if (hash_type == HASH_MD5) {
2509 key = tokens[2];
2510 msg_size = NTP_MSGSIZE_MD5_AUTH;
2511 } else /* it's hash_type == HASH_SHA1 */
2512 if (!(key_length & 1)) {
2513 key_length >>= 1;
2514 if (!hex2bin(buffer, tokens[2], key_length))
2515 goto err;
2516 key = buffer;
2517 msg_size = NTP_MSGSIZE_SHA1_AUTH;
2518 } else {
2519 goto err;
2520 }
2521 key_entry = xzalloc(sizeof(*key_entry) + key_length);
2522 key_entry->type = hash_type;
2523 key_entry->msg_size = msg_size;
2524 key_entry->key_length = key_length;
2525 memcpy(key_entry->key, key, key_length);
2526 key_entry->id = xatou_range(tokens[0], 1, MAX_KEY_NUMBER);
2527 llist_add_to(&key_entries, key_entry);
2528 }
2529 config_close(parser);
2530 }
2531#endif
Denys Vlasenkod6782572010-10-04 01:20:44 +02002532 if (peers) {
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002533#if ENABLE_FEATURE_NTP_AUTH
2534 while (peers) {
2535 char *peer = llist_pop(&peers);
2536 key_entry_t *key_entry = NULL;
2537 if (strncmp(peer, "keyno:", 6) == 0) {
2538 char *end;
2539 int key_id;
2540 peer += 6;
2541 end = strchr(peer, ':');
Denys Vlasenko0d18e5c2018-11-25 00:42:56 +01002542 if (!end) bb_show_usage();
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002543 *end = '\0';
2544 key_id = xatou_range(peer, 1, MAX_KEY_NUMBER);
2545 *end = ':';
2546 key_entry = find_key_entry(key_entries, key_id);
2547 peer = end + 1;
2548 }
2549 add_peers(peer, key_entry);
2550 }
2551#else
Denys Vlasenkod6782572010-10-04 01:20:44 +02002552 while (peers)
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002553 add_peers(llist_pop(&peers), NULL);
2554#endif
Denys Vlasenko504fe452014-03-23 15:06:38 +01002555 }
2556#if ENABLE_FEATURE_NTPD_CONF
2557 else {
2558 parser_t *parser;
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002559 char *token[3 + 2*ENABLE_FEATURE_NTP_AUTH];
Denys Vlasenko504fe452014-03-23 15:06:38 +01002560
2561 parser = config_open("/etc/ntp.conf");
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002562 while (config_read(parser, token, 3 + 2*ENABLE_FEATURE_NTP_AUTH, 1, "# \t", PARSE_NORMAL)) {
Denys Vlasenko504fe452014-03-23 15:06:38 +01002563 if (strcmp(token[0], "server") == 0 && token[1]) {
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002564# if ENABLE_FEATURE_NTP_AUTH
2565 key_entry_t *key_entry = NULL;
2566 if (token[2] && token[3] && strcmp(token[2], "key") == 0) {
2567 unsigned key_id = xatou_range(token[3], 1, MAX_KEY_NUMBER);
2568 key_entry = find_key_entry(key_entries, key_id);
2569 }
2570 add_peers(token[1], key_entry);
2571# else
2572 add_peers(token[1], NULL);
2573# endif
Denys Vlasenko504fe452014-03-23 15:06:38 +01002574 continue;
2575 }
2576 bb_error_msg("skipping %s:%u: unimplemented command '%s'",
2577 "/etc/ntp.conf", parser->lineno, token[0]
2578 );
2579 }
2580 config_close(parser);
2581 }
2582#endif
2583 if (G.peer_cnt == 0) {
2584 if (!(opts & OPT_l))
2585 bb_show_usage();
Denys Vlasenkod6782572010-10-04 01:20:44 +02002586 /* -l but no peers: "stratum 1 server" mode */
2587 G.stratum = 1;
2588 }
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002589 /* If network is up, syncronization occurs in ~10 seconds.
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002590 * We give "ntpd -q" 10 seconds to get first reply,
2591 * then another 50 seconds to finish syncing.
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002592 *
2593 * I tested ntpd 4.2.6p1 and apparently it never exits
2594 * (will try forever), but it does not feel right.
2595 * The goal of -q is to act like ntpdate: set time
2596 * after a reasonably small period of polling, or fail.
2597 */
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002598 if (opts & OPT_q) {
2599 option_mask32 |= OPT_qq;
2600 alarm(10);
2601 }
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002602
2603 bb_signals(0
2604 | (1 << SIGTERM)
2605 | (1 << SIGINT)
2606 | (1 << SIGALRM)
2607 , record_signo
2608 );
2609 bb_signals(0
2610 | (1 << SIGPIPE)
2611 | (1 << SIGCHLD)
2612 , SIG_IGN
2613 );
Brandon P. Enochsa5413142018-10-27 18:55:59 +02002614//TODO: free unused elements of key_entries?
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002615}
2616
2617int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2618int ntpd_main(int argc UNUSED_PARAM, char **argv)
2619{
Denys Vlasenko0b002812010-01-03 08:59:59 +01002620#undef G
2621 struct globals G;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002622 struct pollfd *pfd;
2623 peer_t **idx2peer;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002624 unsigned cnt;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002625
Denys Vlasenko0b002812010-01-03 08:59:59 +01002626 memset(&G, 0, sizeof(G));
2627 SET_PTR_TO_GLOBALS(&G);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002628
2629 ntp_init(argv);
2630
Denys Vlasenko0b002812010-01-03 08:59:59 +01002631 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2632 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2633 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2634 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2635
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002636 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002637 * packets to each peer.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002638 * NB: if some peer is not responding, we may end up sending
2639 * fewer packets to it and more to other peers.
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002640 * NB2: sync usually happens using INITIAL_SAMPLES packets,
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002641 * since last reply does not come back instantaneously.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002642 */
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002643 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002644
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002645 write_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2646
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002647 while (!bb_got_signal) {
2648 llist_t *item;
2649 unsigned i, j;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002650 int nfds, timeout;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002651 double nextaction;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002652
2653 /* Nothing between here and poll() blocks for any significant time */
2654
Denys Vlasenko36acc462017-12-26 20:19:37 +01002655 nextaction = G.last_script_run + (11*60);
2656 if (nextaction < G.cur_time + 1)
2657 nextaction = G.cur_time + 1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002658
2659 i = 0;
2660#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002661 if (G_listen_fd != -1) {
2662 pfd[0].fd = G_listen_fd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002663 pfd[0].events = POLLIN;
2664 i++;
2665 }
2666#endif
2667 /* Pass over peer list, send requests, time out on receives */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002668 for (item = G.ntp_peers; item != NULL; item = item->link) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002669 peer_t *p = (peer_t *) item->data;
2670
Denys Vlasenko0b002812010-01-03 08:59:59 +01002671 if (p->next_action_time <= G.cur_time) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002672 if (p->p_fd == -1) {
2673 /* Time to send new req */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002674 if (--cnt == 0) {
Miroslav Lichvarfb143f72014-09-18 16:19:03 +02002675 VERB4 bb_error_msg("disabling burst mode");
2676 G.polladj_count = 0;
2677 G.poll_exp = MINPOLL;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002678 }
2679 send_query_to_peer(p);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002680 } else {
2681 /* Timed out waiting for reply */
2682 close(p->p_fd);
2683 p->p_fd = -1;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002684 /* If poll interval is small, increase it */
2685 if (G.poll_exp < BIGPOLL)
2686 adjust_poll(MINPOLL);
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002687 timeout = poll_interval(NOREPLY_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002688 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
Denys Vlasenko0b002812010-01-03 08:59:59 +01002689 p->p_dotted, p->reachable_bits, timeout);
Denys Vlasenkoc8641962016-03-04 07:26:08 +01002690
2691 /* What if don't see it because it changed its IP? */
Denys Vlasenkoe4caf1d2016-06-06 02:26:49 +02002692 if (p->reachable_bits == 0)
Natanael Copab62ea342017-01-06 16:18:45 +01002693 resolve_peer_hostname(p);
Denys Vlasenkoc8641962016-03-04 07:26:08 +01002694
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002695 set_next(p, timeout);
2696 }
2697 }
2698
2699 if (p->next_action_time < nextaction)
2700 nextaction = p->next_action_time;
2701
2702 if (p->p_fd >= 0) {
2703 /* Wait for reply from this peer */
2704 pfd[i].fd = p->p_fd;
2705 pfd[i].events = POLLIN;
2706 idx2peer[i] = p;
2707 i++;
2708 }
2709 }
2710
Denys Vlasenko0b002812010-01-03 08:59:59 +01002711 timeout = nextaction - G.cur_time;
2712 if (timeout < 0)
2713 timeout = 0;
2714 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002715
2716 /* Here we may block */
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002717 VERB2 {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002718 if (i > (ENABLE_FEATURE_NTPD_SERVER && G_listen_fd != -1)) {
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002719 /* We wait for at least one reply.
2720 * Poll for it, without wasting time for message.
2721 * Since replies often come under 1 second, this also
2722 * reduces clutter in logs.
2723 */
2724 nfds = poll(pfd, i, 1000);
2725 if (nfds != 0)
2726 goto did_poll;
2727 if (--timeout <= 0)
2728 goto did_poll;
2729 }
Denys Vlasenko8be49c32012-03-06 19:16:50 +01002730 bb_error_msg("poll:%us sockets:%u interval:%us", timeout, i, 1 << G.poll_exp);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002731 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002732 nfds = poll(pfd, i, timeout * 1000);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002733 did_poll:
Denys Vlasenko0b002812010-01-03 08:59:59 +01002734 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002735 if (nfds <= 0) {
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002736 double ct;
Denys Vlasenkod5c14822017-10-31 16:53:23 +01002737 int dns_error;
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002738
2739 if (bb_got_signal)
2740 break; /* poll was interrupted by a signal */
2741
2742 if (G.cur_time - G.last_script_run > 11*60) {
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002743 /* Useful for updating battery-backed RTC and such */
Denys Vlasenko12628b72010-01-11 01:31:59 +01002744 run_script("periodic", G.last_update_offset);
Denys Vlasenko06667f22010-01-06 13:05:08 +01002745 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002746 }
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002747
2748 /* Resolve peer names to IPs, if not resolved yet.
2749 * We do it only when poll timed out:
2750 * this way, we almost never overlap DNS resolution with
2751 * "request-reply" packet round trip.
2752 */
Denys Vlasenkod5c14822017-10-31 16:53:23 +01002753 dns_error = 0;
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002754 ct = G.cur_time;
2755 for (item = G.ntp_peers; item != NULL; item = item->link) {
2756 peer_t *p = (peer_t *) item->data;
2757 if (p->next_action_time <= ct && !p->p_lsa) {
2758 /* This can take up to ~10 sec per each DNS query */
Denys Vlasenkod5c14822017-10-31 16:53:23 +01002759 dns_error |= (!resolve_peer_hostname(p));
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002760 }
2761 }
Denys Vlasenkod5c14822017-10-31 16:53:23 +01002762 if (!dns_error)
2763 goto check_unsync;
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002764 /* Set next time for those which are still not resolved */
Denys Vlasenkod5c14822017-10-31 16:53:23 +01002765 gettime1900d(); /* sets G.cur_time (needed for set_next()) */
Denys Vlasenko6a4f2232017-10-31 12:44:37 +01002766 for (item = G.ntp_peers; item != NULL; item = item->link) {
2767 peer_t *p = (peer_t *) item->data;
2768 if (p->next_action_time <= ct && !p->p_lsa) {
2769 set_next(p, HOSTNAME_INTERVAL * p->dns_errors);
2770 }
2771 }
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002772 goto check_unsync;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002773 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002774
2775 /* Process any received packets */
2776 j = 0;
2777#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01002778 if (G.listen_fd != -1) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002779 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2780 nfds--;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002781 recv_and_process_client_pkt(/*G.listen_fd*/);
2782 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002783 }
2784 j = 1;
2785 }
2786#endif
2787 for (; nfds != 0 && j < i; j++) {
2788 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002789 /*
2790 * At init, alarm was set to 10 sec.
2791 * Now we did get a reply.
2792 * Increase timeout to 50 seconds to finish syncing.
2793 */
2794 if (option_mask32 & OPT_qq) {
2795 option_mask32 &= ~OPT_qq;
2796 alarm(50);
2797 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002798 nfds--;
2799 recv_and_process_peer_pkt(idx2peer[j]);
Denys Vlasenko0b002812010-01-03 08:59:59 +01002800 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002801 }
2802 }
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002803
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002804 check_unsync:
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002805 if (G.ntp_peers && G.stratum != MAXSTRAT) {
2806 for (item = G.ntp_peers; item != NULL; item = item->link) {
2807 peer_t *p = (peer_t *) item->data;
2808 if (p->reachable_bits)
2809 goto have_reachable_peer;
2810 }
2811 /* No peer responded for last 8 packets, panic */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002812 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02002813 run_script("unsync", 0.0);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002814 have_reachable_peer: ;
2815 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002816 } /* while (!bb_got_signal) */
2817
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002818 remove_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002819 kill_myself_with_sig(bb_got_signal);
2820}
2821
2822
2823
2824
2825
2826
2827/*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2828
2829/*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2830
2831#if 0
2832static double
2833direct_freq(double fp_offset)
2834{
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002835#ifdef KERNEL_PLL
2836 /*
2837 * If the kernel is enabled, we need the residual offset to
2838 * calculate the frequency correction.
2839 */
2840 if (pll_control && kern_enable) {
2841 memset(&ntv, 0, sizeof(ntv));
2842 ntp_adjtime(&ntv);
2843#ifdef STA_NANO
2844 clock_offset = ntv.offset / 1e9;
2845#else /* STA_NANO */
2846 clock_offset = ntv.offset / 1e6;
2847#endif /* STA_NANO */
2848 drift_comp = FREQTOD(ntv.freq);
2849 }
2850#endif /* KERNEL_PLL */
2851 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2852 wander_resid = 0;
2853 return drift_comp;
2854}
2855
2856static void
Denys Vlasenkofb132e42010-10-29 11:46:52 +02002857set_freq(double freq) /* frequency update */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002858{
2859 char tbuf[80];
2860
2861 drift_comp = freq;
2862
2863#ifdef KERNEL_PLL
2864 /*
2865 * If the kernel is enabled, update the kernel frequency.
2866 */
2867 if (pll_control && kern_enable) {
2868 memset(&ntv, 0, sizeof(ntv));
2869 ntv.modes = MOD_FREQUENCY;
2870 ntv.freq = DTOFREQ(drift_comp);
2871 ntp_adjtime(&ntv);
2872 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2873 report_event(EVNT_FSET, NULL, tbuf);
2874 } else {
2875 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2876 report_event(EVNT_FSET, NULL, tbuf);
2877 }
2878#else /* KERNEL_PLL */
2879 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2880 report_event(EVNT_FSET, NULL, tbuf);
2881#endif /* KERNEL_PLL */
2882}
2883
2884...
2885...
2886...
2887
2888#ifdef KERNEL_PLL
2889 /*
2890 * This code segment works when clock adjustments are made using
2891 * precision time kernel support and the ntp_adjtime() system
2892 * call. This support is available in Solaris 2.6 and later,
2893 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2894 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2895 * DECstation 5000/240 and Alpha AXP, additional kernel
2896 * modifications provide a true microsecond clock and nanosecond
2897 * clock, respectively.
2898 *
2899 * Important note: The kernel discipline is used only if the
2900 * step threshold is less than 0.5 s, as anything higher can
2901 * lead to overflow problems. This might occur if some misguided
2902 * lad set the step threshold to something ridiculous.
2903 */
2904 if (pll_control && kern_enable) {
2905
2906#define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2907
2908 /*
2909 * We initialize the structure for the ntp_adjtime()
2910 * system call. We have to convert everything to
2911 * microseconds or nanoseconds first. Do not update the
2912 * system variables if the ext_enable flag is set. In
2913 * this case, the external clock driver will update the
2914 * variables, which will be read later by the local
2915 * clock driver. Afterwards, remember the time and
2916 * frequency offsets for jitter and stability values and
2917 * to update the frequency file.
2918 */
2919 memset(&ntv, 0, sizeof(ntv));
2920 if (ext_enable) {
2921 ntv.modes = MOD_STATUS;
2922 } else {
2923#ifdef STA_NANO
2924 ntv.modes = MOD_BITS | MOD_NANO;
2925#else /* STA_NANO */
2926 ntv.modes = MOD_BITS;
2927#endif /* STA_NANO */
2928 if (clock_offset < 0)
2929 dtemp = -.5;
2930 else
2931 dtemp = .5;
2932#ifdef STA_NANO
2933 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2934 ntv.constant = sys_poll;
2935#else /* STA_NANO */
2936 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2937 ntv.constant = sys_poll - 4;
2938#endif /* STA_NANO */
2939 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2940 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2941 ntv.status = STA_PLL;
2942
2943 /*
2944 * Enable/disable the PPS if requested.
2945 */
2946 if (pps_enable) {
2947 if (!(pll_status & STA_PPSTIME))
2948 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002949 NULL, "PPS enabled");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002950 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2951 } else {
2952 if (pll_status & STA_PPSTIME)
2953 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002954 NULL, "PPS disabled");
2955 ntv.status &= ~(STA_PPSTIME | STA_PPSFREQ);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002956 }
2957 if (sys_leap == LEAP_ADDSECOND)
2958 ntv.status |= STA_INS;
2959 else if (sys_leap == LEAP_DELSECOND)
2960 ntv.status |= STA_DEL;
2961 }
2962
2963 /*
2964 * Pass the stuff to the kernel. If it squeals, turn off
2965 * the pps. In any case, fetch the kernel offset,
2966 * frequency and jitter.
2967 */
2968 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2969 if (!(ntv.status & STA_PPSSIGNAL))
2970 report_event(EVNT_KERN, NULL,
Denys Vlasenko69675782013-01-14 01:34:48 +01002971 "PPS no signal");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002972 }
2973 pll_status = ntv.status;
2974#ifdef STA_NANO
2975 clock_offset = ntv.offset / 1e9;
2976#else /* STA_NANO */
2977 clock_offset = ntv.offset / 1e6;
2978#endif /* STA_NANO */
2979 clock_frequency = FREQTOD(ntv.freq);
2980
2981 /*
2982 * If the kernel PPS is lit, monitor its performance.
2983 */
2984 if (ntv.status & STA_PPSTIME) {
2985#ifdef STA_NANO
2986 clock_jitter = ntv.jitter / 1e9;
2987#else /* STA_NANO */
2988 clock_jitter = ntv.jitter / 1e6;
2989#endif /* STA_NANO */
2990 }
2991
2992#if defined(STA_NANO) && NTP_API == 4
2993 /*
2994 * If the TAI changes, update the kernel TAI.
2995 */
2996 if (loop_tai != sys_tai) {
2997 loop_tai = sys_tai;
2998 ntv.modes = MOD_TAI;
2999 ntv.constant = sys_tai;
3000 ntp_adjtime(&ntv);
3001 }
3002#endif /* STA_NANO */
3003 }
3004#endif /* KERNEL_PLL */
3005#endif