]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/timesync/timesyncd-manager.c
Merge pull request #142 from teg/sd-network-unref-NULL
[thirdparty/systemd.git] / src / timesync / timesyncd-manager.c
CommitLineData
84e51726
LP
1/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3/***
4 This file is part of systemd.
5
6 Copyright 2014 Kay Sievers, Lennart Poettering
7
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20***/
21
22#include <stdlib.h>
23#include <errno.h>
84e51726
LP
24#include <time.h>
25#include <math.h>
84e51726
LP
26#include <netinet/in.h>
27#include <netinet/ip.h>
28#include <sys/timerfd.h>
29#include <sys/timex.h>
30#include <sys/socket.h>
31#include <resolv.h>
84e51726 32#include <sys/types.h>
84e51726
LP
33
34#include "missing.h"
35#include "util.h"
36#include "sparse-endian.h"
37#include "log.h"
38#include "socket-util.h"
39#include "list.h"
40#include "ratelimit.h"
41#include "strv.h"
84e51726 42#include "sd-daemon.h"
84e51726 43#include "network-util.h"
84e51726
LP
44#include "timesyncd-conf.h"
45#include "timesyncd-manager.h"
e4746b57 46#include "time-util.h"
84e51726
LP
47
48#ifndef ADJ_SETOFFSET
49#define ADJ_SETOFFSET 0x0100 /* add 'time' to current time */
50#endif
51
52/* expected accuracy of time synchronization; used to adjust the poll interval */
53#define NTP_ACCURACY_SEC 0.2
54
55/*
56 * "A client MUST NOT under any conditions use a poll interval less
57 * than 15 seconds."
58 */
59#define NTP_POLL_INTERVAL_MIN_SEC 32
60#define NTP_POLL_INTERVAL_MAX_SEC 2048
61
62/*
63 * Maximum delta in seconds which the system clock is gradually adjusted
64 * (slew) to approach the network time. Deltas larger that this are set by
65 * letting the system time jump. The kernel's limit for adjtime is 0.5s.
66 */
67#define NTP_MAX_ADJUST 0.4
68
69/* NTP protocol, packet header */
70#define NTP_LEAP_PLUSSEC 1
71#define NTP_LEAP_MINUSSEC 2
72#define NTP_LEAP_NOTINSYNC 3
73#define NTP_MODE_CLIENT 3
74#define NTP_MODE_SERVER 4
75#define NTP_FIELD_LEAP(f) (((f) >> 6) & 3)
76#define NTP_FIELD_VERSION(f) (((f) >> 3) & 7)
77#define NTP_FIELD_MODE(f) ((f) & 7)
78#define NTP_FIELD(l, v, m) (((l) << 6) | ((v) << 3) | (m))
79
3af0442c
ML
80/* Maximum acceptable root distance in seconds. */
81#define NTP_MAX_ROOT_DISTANCE 5.0
82
e8206972
ML
83/* Maximum number of missed replies before selecting another source. */
84#define NTP_MAX_MISSED_REPLIES 2
85
84e51726
LP
86/*
87 * "NTP timestamps are represented as a 64-bit unsigned fixed-point number,
88 * in seconds relative to 0h on 1 January 1900."
89 */
625b3b71 90#define OFFSET_1900_1970 UINT64_C(2208988800)
84e51726
LP
91
92#define RETRY_USEC (30*USEC_PER_SEC)
93#define RATELIMIT_INTERVAL_USEC (10*USEC_PER_SEC)
94#define RATELIMIT_BURST 10
95
96#define TIMEOUT_USEC (10*USEC_PER_SEC)
97
98struct ntp_ts {
99 be32_t sec;
100 be32_t frac;
101} _packed_;
102
103struct ntp_ts_short {
104 be16_t sec;
105 be16_t frac;
106} _packed_;
107
108struct ntp_msg {
109 uint8_t field;
110 uint8_t stratum;
111 int8_t poll;
112 int8_t precision;
113 struct ntp_ts_short root_delay;
114 struct ntp_ts_short root_dispersion;
115 char refid[4];
116 struct ntp_ts reference_time;
117 struct ntp_ts origin_time;
118 struct ntp_ts recv_time;
119 struct ntp_ts trans_time;
120} _packed_;
121
122static int manager_arm_timer(Manager *m, usec_t next);
123static int manager_clock_watch_setup(Manager *m);
7b628891 124static int manager_listen_setup(Manager *m);
f89c4e15 125static void manager_listen_stop(Manager *m);
84e51726 126
3af0442c
ML
127static double ntp_ts_short_to_d(const struct ntp_ts_short *ts) {
128 return be16toh(ts->sec) + (be16toh(ts->frac) / 65536.0);
129}
130
84e51726
LP
131static double ntp_ts_to_d(const struct ntp_ts *ts) {
132 return be32toh(ts->sec) + ((double)be32toh(ts->frac) / UINT_MAX);
133}
134
135static double ts_to_d(const struct timespec *ts) {
136 return ts->tv_sec + (1.0e-9 * ts->tv_nsec);
137}
138
84e51726
LP
139static int manager_timeout(sd_event_source *source, usec_t usec, void *userdata) {
140 _cleanup_free_ char *pretty = NULL;
141 Manager *m = userdata;
142
143 assert(m);
144 assert(m->current_server_name);
145 assert(m->current_server_address);
146
147 server_address_pretty(m->current_server_address, &pretty);
148 log_info("Timed out waiting for reply from %s (%s).", strna(pretty), m->current_server_name->string);
149
150 return manager_connect(m);
151}
152
153static int manager_send_request(Manager *m) {
154 _cleanup_free_ char *pretty = NULL;
155 struct ntp_msg ntpmsg = {
156 /*
157 * "The client initializes the NTP message header, sends the request
158 * to the server, and strips the time of day from the Transmit
159 * Timestamp field of the reply. For this purpose, all the NTP
160 * header fields are set to 0, except the Mode, VN, and optional
161 * Transmit Timestamp fields."
162 */
163 .field = NTP_FIELD(0, 4, NTP_MODE_CLIENT),
164 };
165 ssize_t len;
166 int r;
167
168 assert(m);
169 assert(m->current_server_name);
170 assert(m->current_server_address);
171
172 m->event_timeout = sd_event_source_unref(m->event_timeout);
173
f89c4e15
LP
174 r = manager_listen_setup(m);
175 if (r < 0)
176 return log_warning_errno(r, "Failed to setup connection socket: %m");
7b628891 177
84e51726
LP
178 /*
179 * Set transmit timestamp, remember it; the server will send that back
180 * as the origin timestamp and we have an indication that this is the
181 * matching answer to our request.
182 *
183 * The actual value does not matter, We do not care about the correct
184 * NTP UINT_MAX fraction; we just pass the plain nanosecond value.
185 */
186 assert_se(clock_gettime(clock_boottime_or_monotonic(), &m->trans_time_mon) >= 0);
187 assert_se(clock_gettime(CLOCK_REALTIME, &m->trans_time) >= 0);
188 ntpmsg.trans_time.sec = htobe32(m->trans_time.tv_sec + OFFSET_1900_1970);
189 ntpmsg.trans_time.frac = htobe32(m->trans_time.tv_nsec);
190
191 server_address_pretty(m->current_server_address, &pretty);
192
193 len = sendto(m->server_socket, &ntpmsg, sizeof(ntpmsg), MSG_DONTWAIT, &m->current_server_address->sockaddr.sa, m->current_server_address->socklen);
194 if (len == sizeof(ntpmsg)) {
195 m->pending = true;
196 log_debug("Sent NTP request to %s (%s).", strna(pretty), m->current_server_name->string);
197 } else {
56f64d95 198 log_debug_errno(errno, "Sending NTP request to %s (%s) failed: %m", strna(pretty), m->current_server_name->string);
84e51726
LP
199 return manager_connect(m);
200 }
201
ab4df227
KS
202 /* re-arm timer with increasing timeout, in case the packets never arrive back */
203 if (m->retry_interval > 0) {
204 if (m->retry_interval < NTP_POLL_INTERVAL_MAX_SEC * USEC_PER_SEC)
205 m->retry_interval *= 2;
206 } else
207 m->retry_interval = NTP_POLL_INTERVAL_MIN_SEC * USEC_PER_SEC;
208
209 r = manager_arm_timer(m, m->retry_interval);
f647962d
MS
210 if (r < 0)
211 return log_error_errno(r, "Failed to rearm timer: %m");
ab4df227 212
e8206972
ML
213 m->missed_replies++;
214 if (m->missed_replies > NTP_MAX_MISSED_REPLIES) {
215 r = sd_event_add_time(
216 m->event,
217 &m->event_timeout,
218 clock_boottime_or_monotonic(),
219 now(clock_boottime_or_monotonic()) + TIMEOUT_USEC, 0,
220 manager_timeout, m);
f647962d
MS
221 if (r < 0)
222 return log_error_errno(r, "Failed to arm timeout timer: %m");
84e51726
LP
223 }
224
225 return 0;
226}
227
228static int manager_timer(sd_event_source *source, usec_t usec, void *userdata) {
229 Manager *m = userdata;
230
231 assert(m);
232
233 return manager_send_request(m);
234}
235
236static int manager_arm_timer(Manager *m, usec_t next) {
237 int r;
238
239 assert(m);
84e51726
LP
240
241 if (next == 0) {
242 m->event_timer = sd_event_source_unref(m->event_timer);
243 return 0;
244 }
245
246 if (m->event_timer) {
247 r = sd_event_source_set_time(m->event_timer, now(clock_boottime_or_monotonic()) + next);
248 if (r < 0)
249 return r;
250
251 return sd_event_source_set_enabled(m->event_timer, SD_EVENT_ONESHOT);
252 }
253
254 return sd_event_add_time(
255 m->event,
256 &m->event_timer,
257 clock_boottime_or_monotonic(),
258 now(clock_boottime_or_monotonic()) + next, 0,
259 manager_timer, m);
260}
261
262static int manager_clock_watch(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
263 Manager *m = userdata;
264
265 assert(m);
266
267 /* rearm timer */
268 manager_clock_watch_setup(m);
269
270 /* skip our own jumps */
271 if (m->jumped) {
272 m->jumped = false;
273 return 0;
274 }
275
276 /* resync */
7e3254b3 277 log_debug("System time changed. Resyncing.");
84e51726
LP
278 m->poll_resync = true;
279
280 return manager_send_request(m);
281}
282
283/* wake up when the system time changes underneath us */
284static int manager_clock_watch_setup(Manager *m) {
285
286 struct itimerspec its = {
287 .it_value.tv_sec = TIME_T_MAX
288 };
289
290 int r;
291
292 assert(m);
293
294 m->event_clock_watch = sd_event_source_unref(m->event_clock_watch);
295 safe_close(m->clock_watch_fd);
296
297 m->clock_watch_fd = timerfd_create(CLOCK_REALTIME, TFD_NONBLOCK|TFD_CLOEXEC);
4a62c710
MS
298 if (m->clock_watch_fd < 0)
299 return log_error_errno(errno, "Failed to create timerfd: %m");
84e51726 300
4a62c710
MS
301 if (timerfd_settime(m->clock_watch_fd, TFD_TIMER_ABSTIME|TFD_TIMER_CANCEL_ON_SET, &its, NULL) < 0)
302 return log_error_errno(errno, "Failed to set up timerfd: %m");
84e51726
LP
303
304 r = sd_event_add_io(m->event, &m->event_clock_watch, m->clock_watch_fd, EPOLLIN, manager_clock_watch, m);
f647962d
MS
305 if (r < 0)
306 return log_error_errno(r, "Failed to create clock watch event source: %m");
84e51726
LP
307
308 return 0;
309}
310
311static int manager_adjust_clock(Manager *m, double offset, int leap_sec) {
312 struct timex tmx = {};
313 int r;
314
315 assert(m);
316
317 /*
318 * For small deltas, tell the kernel to gradually adjust the system
319 * clock to the NTP time, larger deltas are just directly set.
320 */
321 if (fabs(offset) < NTP_MAX_ADJUST) {
322 tmx.modes = ADJ_STATUS | ADJ_NANO | ADJ_OFFSET | ADJ_TIMECONST | ADJ_MAXERROR | ADJ_ESTERROR;
323 tmx.status = STA_PLL;
324 tmx.offset = offset * NSEC_PER_SEC;
325 tmx.constant = log2i(m->poll_interval_usec / USEC_PER_SEC) - 4;
326 tmx.maxerror = 0;
327 tmx.esterror = 0;
ff49bc32 328 log_debug(" adjust (slew): %+.3f sec", offset);
84e51726
LP
329 } else {
330 tmx.modes = ADJ_STATUS | ADJ_NANO | ADJ_SETOFFSET;
331
332 /* ADJ_NANO uses nanoseconds in the microseconds field */
333 tmx.time.tv_sec = (long)offset;
334 tmx.time.tv_usec = (offset - tmx.time.tv_sec) * NSEC_PER_SEC;
335
336 /* the kernel expects -0.3s as {-1, 7000.000.000} */
337 if (tmx.time.tv_usec < 0) {
338 tmx.time.tv_sec -= 1;
339 tmx.time.tv_usec += NSEC_PER_SEC;
340 }
341
342 m->jumped = true;
ff49bc32 343 log_debug(" adjust (jump): %+.3f sec", offset);
84e51726
LP
344 }
345
346 /*
347 * An unset STA_UNSYNC will enable the kernel's 11-minute mode,
348 * which syncs the system time periodically to the RTC.
349 *
350 * In case the RTC runs in local time, never touch the RTC,
351 * we have no way to properly handle daylight saving changes and
352 * mobile devices moving between time zones.
353 */
354 if (m->rtc_local_time)
355 tmx.status |= STA_UNSYNC;
356
357 switch (leap_sec) {
358 case 1:
359 tmx.status |= STA_INS;
360 break;
361 case -1:
362 tmx.status |= STA_DEL;
363 break;
364 }
365
366 r = clock_adjtime(CLOCK_REALTIME, &tmx);
367 if (r < 0)
368 return r;
369
370 touch("/var/lib/systemd/clock");
371
372 m->drift_ppm = tmx.freq / 65536;
373
374 log_debug(" status : %04i %s\n"
375 " time now : %li.%03llu\n"
376 " constant : %li\n"
377 " offset : %+.3f sec\n"
378 " freq offset : %+li (%i ppm)\n",
379 tmx.status, tmx.status & STA_UNSYNC ? "unsync" : "sync",
380 tmx.time.tv_sec, (unsigned long long) (tmx.time.tv_usec / NSEC_PER_MSEC),
381 tmx.constant,
382 (double)tmx.offset / NSEC_PER_SEC,
383 tmx.freq, m->drift_ppm);
384
385 return 0;
386}
387
388static bool manager_sample_spike_detection(Manager *m, double offset, double delay) {
389 unsigned int i, idx_cur, idx_new, idx_min;
390 double jitter;
391 double j;
392
393 assert(m);
394
395 m->packet_count++;
396
397 /* ignore initial sample */
398 if (m->packet_count == 1)
399 return false;
400
401 /* store the current data in our samples array */
402 idx_cur = m->samples_idx;
403 idx_new = (idx_cur + 1) % ELEMENTSOF(m->samples);
404 m->samples_idx = idx_new;
405 m->samples[idx_new].offset = offset;
406 m->samples[idx_new].delay = delay;
407
408 /* calculate new jitter value from the RMS differences relative to the lowest delay sample */
409 jitter = m->samples_jitter;
410 for (idx_min = idx_cur, i = 0; i < ELEMENTSOF(m->samples); i++)
411 if (m->samples[i].delay > 0 && m->samples[i].delay < m->samples[idx_min].delay)
412 idx_min = i;
413
414 j = 0;
415 for (i = 0; i < ELEMENTSOF(m->samples); i++)
fa66b606 416 j += pow(m->samples[i].offset - m->samples[idx_min].offset, 2);
84e51726
LP
417 m->samples_jitter = sqrt(j / (ELEMENTSOF(m->samples) - 1));
418
419 /* ignore samples when resyncing */
420 if (m->poll_resync)
421 return false;
422
423 /* always accept offset if we are farther off than the round-trip delay */
424 if (fabs(offset) > delay)
425 return false;
426
427 /* we need a few samples before looking at them */
428 if (m->packet_count < 4)
429 return false;
430
431 /* do not accept anything worse than the maximum possible error of the best sample */
432 if (fabs(offset) > m->samples[idx_min].delay)
433 return true;
434
435 /* compare the difference between the current offset to the previous offset and jitter */
436 return fabs(offset - m->samples[idx_cur].offset) > 3 * jitter;
437}
438
439static void manager_adjust_poll(Manager *m, double offset, bool spike) {
440 assert(m);
441
442 if (m->poll_resync) {
443 m->poll_interval_usec = NTP_POLL_INTERVAL_MIN_SEC * USEC_PER_SEC;
444 m->poll_resync = false;
445 return;
446 }
447
448 /* set to minimal poll interval */
449 if (!spike && fabs(offset) > NTP_ACCURACY_SEC) {
450 m->poll_interval_usec = NTP_POLL_INTERVAL_MIN_SEC * USEC_PER_SEC;
451 return;
452 }
453
454 /* increase polling interval */
455 if (fabs(offset) < NTP_ACCURACY_SEC * 0.25) {
456 if (m->poll_interval_usec < NTP_POLL_INTERVAL_MAX_SEC * USEC_PER_SEC)
457 m->poll_interval_usec *= 2;
458 return;
459 }
460
461 /* decrease polling interval */
462 if (spike || fabs(offset) > NTP_ACCURACY_SEC * 0.75) {
463 if (m->poll_interval_usec > NTP_POLL_INTERVAL_MIN_SEC * USEC_PER_SEC)
464 m->poll_interval_usec /= 2;
465 return;
466 }
467}
468
469static int manager_receive_response(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
470 Manager *m = userdata;
471 struct ntp_msg ntpmsg;
472
473 struct iovec iov = {
474 .iov_base = &ntpmsg,
475 .iov_len = sizeof(ntpmsg),
476 };
477 union {
478 struct cmsghdr cmsghdr;
479 uint8_t buf[CMSG_SPACE(sizeof(struct timeval))];
480 } control;
481 union sockaddr_union server_addr;
482 struct msghdr msghdr = {
483 .msg_iov = &iov,
484 .msg_iovlen = 1,
485 .msg_control = &control,
486 .msg_controllen = sizeof(control),
487 .msg_name = &server_addr,
488 .msg_namelen = sizeof(server_addr),
489 };
490 struct cmsghdr *cmsg;
487a3682 491 struct timespec *recv_time;
84e51726
LP
492 ssize_t len;
493 double origin, receive, trans, dest;
494 double delay, offset;
3af0442c 495 double root_distance;
84e51726
LP
496 bool spike;
497 int leap_sec;
498 int r;
499
500 assert(source);
501 assert(m);
502
503 if (revents & (EPOLLHUP|EPOLLERR)) {
504 log_warning("Server connection returned error.");
505 return manager_connect(m);
506 }
507
a38d9945 508 len = recvmsg(fd, &msghdr, MSG_DONTWAIT);
84e51726
LP
509 if (len < 0) {
510 if (errno == EAGAIN)
511 return 0;
512
513 log_warning("Error receiving message. Disconnecting.");
514 return manager_connect(m);
515 }
516
43fcd650
TM
517 /* Too short or too long packet? */
518 if (iov.iov_len < sizeof(struct ntp_msg) || (msghdr.msg_flags & MSG_TRUNC)) {
84e51726
LP
519 log_warning("Invalid response from server. Disconnecting.");
520 return manager_connect(m);
521 }
522
523 if (!m->current_server_name ||
524 !m->current_server_address ||
525 !sockaddr_equal(&server_addr, &m->current_server_address->sockaddr)) {
526 log_debug("Response from unknown server.");
527 return 0;
528 }
529
530 recv_time = NULL;
531 for (cmsg = CMSG_FIRSTHDR(&msghdr); cmsg; cmsg = CMSG_NXTHDR(&msghdr, cmsg)) {
532 if (cmsg->cmsg_level != SOL_SOCKET)
533 continue;
534
535 switch (cmsg->cmsg_type) {
487a3682
ML
536 case SCM_TIMESTAMPNS:
537 recv_time = (struct timespec *) CMSG_DATA(cmsg);
84e51726
LP
538 break;
539 }
540 }
541 if (!recv_time) {
542 log_error("Invalid packet timestamp.");
543 return -EINVAL;
544 }
545
546 if (!m->pending) {
547 log_debug("Unexpected reply. Ignoring.");
548 return 0;
549 }
550
e8206972
ML
551 m->missed_replies = 0;
552
84e51726
LP
553 /* check our "time cookie" (we just stored nanoseconds in the fraction field) */
554 if (be32toh(ntpmsg.origin_time.sec) != m->trans_time.tv_sec + OFFSET_1900_1970 ||
555 be32toh(ntpmsg.origin_time.frac) != m->trans_time.tv_nsec) {
556 log_debug("Invalid reply; not our transmit time. Ignoring.");
557 return 0;
558 }
559
560 m->event_timeout = sd_event_source_unref(m->event_timeout);
561
562 if (be32toh(ntpmsg.recv_time.sec) < TIME_EPOCH + OFFSET_1900_1970 ||
563 be32toh(ntpmsg.trans_time.sec) < TIME_EPOCH + OFFSET_1900_1970) {
564 log_debug("Invalid reply, returned times before epoch. Ignoring.");
565 return manager_connect(m);
566 }
567
07610e10
ML
568 if (NTP_FIELD_LEAP(ntpmsg.field) == NTP_LEAP_NOTINSYNC ||
569 ntpmsg.stratum == 0 || ntpmsg.stratum >= 16) {
84e51726
LP
570 log_debug("Server is not synchronized. Disconnecting.");
571 return manager_connect(m);
572 }
573
574 if (!IN_SET(NTP_FIELD_VERSION(ntpmsg.field), 3, 4)) {
575 log_debug("Response NTPv%d. Disconnecting.", NTP_FIELD_VERSION(ntpmsg.field));
576 return manager_connect(m);
577 }
578
579 if (NTP_FIELD_MODE(ntpmsg.field) != NTP_MODE_SERVER) {
580 log_debug("Unsupported mode %d. Disconnecting.", NTP_FIELD_MODE(ntpmsg.field));
581 return manager_connect(m);
582 }
583
3af0442c
ML
584 root_distance = ntp_ts_short_to_d(&ntpmsg.root_delay) / 2 + ntp_ts_short_to_d(&ntpmsg.root_dispersion);
585 if (root_distance > NTP_MAX_ROOT_DISTANCE) {
586 log_debug("Server has too large root distance. Disconnecting.");
587 return manager_connect(m);
588 }
589
84e51726
LP
590 /* valid packet */
591 m->pending = false;
ab4df227 592 m->retry_interval = 0;
84e51726 593
7b628891 594 /* Stop listening */
f89c4e15 595 manager_listen_stop(m);
7b628891 596
84e51726
LP
597 /* announce leap seconds */
598 if (NTP_FIELD_LEAP(ntpmsg.field) & NTP_LEAP_PLUSSEC)
599 leap_sec = 1;
600 else if (NTP_FIELD_LEAP(ntpmsg.field) & NTP_LEAP_MINUSSEC)
601 leap_sec = -1;
602 else
603 leap_sec = 0;
604
605 /*
606 * "Timestamp Name ID When Generated
607 * ------------------------------------------------------------
608 * Originate Timestamp T1 time request sent by client
609 * Receive Timestamp T2 time request received by server
610 * Transmit Timestamp T3 time reply sent by server
611 * Destination Timestamp T4 time reply received by client
612 *
613 * The round-trip delay, d, and system clock offset, t, are defined as:
614 * d = (T4 - T1) - (T3 - T2) t = ((T2 - T1) + (T3 - T4)) / 2"
615 */
73c76e63 616 origin = ts_to_d(&m->trans_time) + OFFSET_1900_1970;
84e51726
LP
617 receive = ntp_ts_to_d(&ntpmsg.recv_time);
618 trans = ntp_ts_to_d(&ntpmsg.trans_time);
487a3682 619 dest = ts_to_d(recv_time) + OFFSET_1900_1970;
84e51726
LP
620
621 offset = ((receive - origin) + (trans - dest)) / 2;
622 delay = (dest - origin) - (trans - receive);
623
624 spike = manager_sample_spike_detection(m, offset, delay);
625
626 manager_adjust_poll(m, offset, spike);
627
628 log_debug("NTP response:\n"
629 " leap : %u\n"
630 " version : %u\n"
631 " mode : %u\n"
632 " stratum : %u\n"
633 " precision : %.6f sec (%d)\n"
3af0442c 634 " root distance: %.6f sec\n"
84e51726
LP
635 " reference : %.4s\n"
636 " origin : %.3f\n"
637 " receive : %.3f\n"
638 " transmit : %.3f\n"
639 " dest : %.3f\n"
640 " offset : %+.3f sec\n"
641 " delay : %+.3f sec\n"
642 " packet count : %"PRIu64"\n"
643 " jitter : %.3f%s\n"
644 " poll interval: " USEC_FMT "\n",
645 NTP_FIELD_LEAP(ntpmsg.field),
646 NTP_FIELD_VERSION(ntpmsg.field),
647 NTP_FIELD_MODE(ntpmsg.field),
648 ntpmsg.stratum,
649 exp2(ntpmsg.precision), ntpmsg.precision,
3af0442c 650 root_distance,
84e51726
LP
651 ntpmsg.stratum == 1 ? ntpmsg.refid : "n/a",
652 origin - OFFSET_1900_1970,
653 receive - OFFSET_1900_1970,
654 trans - OFFSET_1900_1970,
655 dest - OFFSET_1900_1970,
656 offset, delay,
657 m->packet_count,
658 m->samples_jitter, spike ? " spike" : "",
659 m->poll_interval_usec / USEC_PER_SEC);
660
661 if (!spike) {
662 m->sync = true;
663 r = manager_adjust_clock(m, offset, leap_sec);
664 if (r < 0)
56f64d95 665 log_error_errno(errno, "Failed to call clock_adjtime(): %m");
84e51726
LP
666 }
667
7b5b3fc3
LP
668 log_debug("interval/delta/delay/jitter/drift " USEC_FMT "s/%+.3fs/%.3fs/%.3fs/%+ippm%s",
669 m->poll_interval_usec / USEC_PER_SEC, offset, delay, m->samples_jitter, m->drift_ppm,
670 spike ? " (ignored)" : "");
84e51726 671
481b3f9e
LP
672 if (!m->good) {
673 _cleanup_free_ char *pretty = NULL;
674
675 m->good = true;
676
677 server_address_pretty(m->current_server_address, &pretty);
678 log_info("Synchronized to time server %s (%s).", strna(pretty), m->current_server_name->string);
679 sd_notifyf(false, "STATUS=Synchronized to time server %s (%s).", strna(pretty), m->current_server_name->string);
680 }
681
84e51726 682 r = manager_arm_timer(m, m->poll_interval_usec);
f647962d
MS
683 if (r < 0)
684 return log_error_errno(r, "Failed to rearm timer: %m");
84e51726
LP
685
686 return 0;
687}
688
689static int manager_listen_setup(Manager *m) {
690 union sockaddr_union addr = {};
691 static const int tos = IPTOS_LOWDELAY;
692 static const int on = 1;
693 int r;
694
695 assert(m);
696
f89c4e15
LP
697 if (m->server_socket >= 0)
698 return 0;
699
84e51726
LP
700 assert(!m->event_receive);
701 assert(m->current_server_address);
702
703 addr.sa.sa_family = m->current_server_address->sockaddr.sa.sa_family;
704
705 m->server_socket = socket(addr.sa.sa_family, SOCK_DGRAM | SOCK_CLOEXEC, 0);
706 if (m->server_socket < 0)
707 return -errno;
708
709 r = bind(m->server_socket, &addr.sa, m->current_server_address->socklen);
710 if (r < 0)
711 return -errno;
712
487a3682 713 r = setsockopt(m->server_socket, SOL_SOCKET, SO_TIMESTAMPNS, &on, sizeof(on));
84e51726
LP
714 if (r < 0)
715 return -errno;
716
69f00817 717 (void) setsockopt(m->server_socket, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
84e51726
LP
718
719 return sd_event_add_io(m->event, &m->event_receive, m->server_socket, EPOLLIN, manager_receive_response, m);
720}
721
f89c4e15
LP
722static void manager_listen_stop(Manager *m) {
723 assert(m);
724
725 m->event_receive = sd_event_source_unref(m->event_receive);
726 m->server_socket = safe_close(m->server_socket);
727}
728
84e51726
LP
729static int manager_begin(Manager *m) {
730 _cleanup_free_ char *pretty = NULL;
731 int r;
732
733 assert(m);
734 assert_return(m->current_server_name, -EHOSTUNREACH);
735 assert_return(m->current_server_address, -EHOSTUNREACH);
736
481b3f9e 737 m->good = false;
e8206972 738 m->missed_replies = NTP_MAX_MISSED_REPLIES;
80cd2606
KS
739 if (m->poll_interval_usec == 0)
740 m->poll_interval_usec = NTP_POLL_INTERVAL_MIN_SEC * USEC_PER_SEC;
84e51726
LP
741
742 server_address_pretty(m->current_server_address, &pretty);
481b3f9e
LP
743 log_debug("Connecting to time server %s (%s).", strna(pretty), m->current_server_name->string);
744 sd_notifyf(false, "STATUS=Connecting to time server %s (%s).", strna(pretty), m->current_server_name->string);
84e51726 745
84e51726
LP
746 r = manager_clock_watch_setup(m);
747 if (r < 0)
748 return r;
749
750 return manager_send_request(m);
751}
752
874ff7bf
LP
753void manager_set_server_name(Manager *m, ServerName *n) {
754 assert(m);
84e51726 755
874ff7bf
LP
756 if (m->current_server_name == n)
757 return;
84e51726 758
874ff7bf
LP
759 m->current_server_name = n;
760 m->current_server_address = NULL;
761
762 manager_disconnect(m);
84e51726 763
874ff7bf
LP
764 if (n)
765 log_debug("Selected server %s.", n->string);
766}
84e51726 767
874ff7bf 768void manager_set_server_address(Manager *m, ServerAddress *a) {
84e51726
LP
769 assert(m);
770
874ff7bf
LP
771 if (m->current_server_address == a)
772 return;
773
874ff7bf 774 m->current_server_address = a;
20f8d3cf
SN
775 /* If a is NULL, we are just clearing the address, without
776 * changing the name. Keep the existing name in that case. */
777 if (a)
778 m->current_server_name = a->name;
874ff7bf
LP
779
780 manager_disconnect(m);
781
782 if (a) {
783 _cleanup_free_ char *pretty = NULL;
784 server_address_pretty(a, &pretty);
785 log_debug("Selected address %s of server %s.", strna(pretty), a->name->string);
84e51726
LP
786 }
787}
788
789static int manager_resolve_handler(sd_resolve_query *q, int ret, const struct addrinfo *ai, void *userdata) {
790 Manager *m = userdata;
874ff7bf 791 int r;
84e51726
LP
792
793 assert(q);
794 assert(m);
795 assert(m->current_server_name);
796
797 m->resolve_query = sd_resolve_query_unref(m->resolve_query);
798
799 if (ret != 0) {
800 log_debug("Failed to resolve %s: %s", m->current_server_name->string, gai_strerror(ret));
801
802 /* Try next host */
803 return manager_connect(m);
804 }
805
84e51726
LP
806 for (; ai; ai = ai->ai_next) {
807 _cleanup_free_ char *pretty = NULL;
874ff7bf 808 ServerAddress *a;
84e51726
LP
809
810 assert(ai->ai_addr);
811 assert(ai->ai_addrlen >= offsetof(struct sockaddr, sa_data));
84e51726
LP
812
813 if (!IN_SET(ai->ai_addr->sa_family, AF_INET, AF_INET6)) {
814 log_warning("Unsuitable address protocol for %s", m->current_server_name->string);
815 continue;
816 }
817
874ff7bf 818 r = server_address_new(m->current_server_name, &a, (const union sockaddr_union*) ai->ai_addr, ai->ai_addrlen);
f647962d
MS
819 if (r < 0)
820 return log_error_errno(r, "Failed to add server address: %m");
84e51726 821
874ff7bf 822 server_address_pretty(a, &pretty);
84e51726
LP
823 log_debug("Resolved address %s for %s.", pretty, m->current_server_name->string);
824 }
825
826 if (!m->current_server_name->addresses) {
827 log_error("Failed to find suitable address for host %s.", m->current_server_name->string);
828
829 /* Try next host */
830 return manager_connect(m);
831 }
832
874ff7bf 833 manager_set_server_address(m, m->current_server_name->addresses);
84e51726
LP
834
835 return manager_begin(m);
836}
837
874ff7bf 838static int manager_retry_connect(sd_event_source *source, usec_t usec, void *userdata) {
84e51726
LP
839 Manager *m = userdata;
840
841 assert(m);
842
843 return manager_connect(m);
844}
845
846int manager_connect(Manager *m) {
84e51726
LP
847 int r;
848
849 assert(m);
850
851 manager_disconnect(m);
852
853 m->event_retry = sd_event_source_unref(m->event_retry);
854 if (!ratelimit_test(&m->ratelimit)) {
855 log_debug("Slowing down attempts to contact servers.");
856
874ff7bf 857 r = sd_event_add_time(m->event, &m->event_retry, clock_boottime_or_monotonic(), now(clock_boottime_or_monotonic()) + RETRY_USEC, 0, manager_retry_connect, m);
f647962d
MS
858 if (r < 0)
859 return log_error_errno(r, "Failed to create retry timer: %m");
84e51726
LP
860
861 return 0;
862 }
863
864 /* If we already are operating on some address, switch to the
865 * next one. */
866 if (m->current_server_address && m->current_server_address->addresses_next)
874ff7bf 867 manager_set_server_address(m, m->current_server_address->addresses_next);
84e51726 868 else {
874ff7bf
LP
869 struct addrinfo hints = {
870 .ai_flags = AI_NUMERICSERV|AI_ADDRCONFIG,
871 .ai_socktype = SOCK_DGRAM,
872 };
84e51726 873
874ff7bf 874 /* Hmm, we are through all addresses, let's look for the next host instead */
84e51726 875 if (m->current_server_name && m->current_server_name->names_next)
874ff7bf 876 manager_set_server_name(m, m->current_server_name->names_next);
84e51726 877 else {
874ff7bf 878 ServerName *f;
63463bf0 879 bool restart = true;
874ff7bf
LP
880
881 /* Our current server name list is exhausted,
882 * let's find the next one to iterate. First
883 * we try the system list, then the link list.
884 * After having processed the link list we
885 * jump back to the system list. However, if
886 * both lists are empty, we change to the
887 * fallback list. */
888 if (!m->current_server_name || m->current_server_name->type == SERVER_LINK) {
889 f = m->system_servers;
890 if (!f)
891 f = m->link_servers;
892 } else {
893 f = m->link_servers;
894 if (!f)
895 f = m->system_servers;
63463bf0
ML
896 else
897 restart = false;
874ff7bf
LP
898 }
899
900 if (!f)
901 f = m->fallback_servers;
902
903 if (!f) {
904 manager_set_server_name(m, NULL);
84e51726
LP
905 log_debug("No server found.");
906 return 0;
907 }
908
63463bf0
ML
909 if (restart && !m->exhausted_servers && m->poll_interval_usec) {
910 log_debug("Waiting after exhausting servers.");
911 r = sd_event_add_time(m->event, &m->event_retry, clock_boottime_or_monotonic(), now(clock_boottime_or_monotonic()) + m->poll_interval_usec, 0, manager_retry_connect, m);
f647962d
MS
912 if (r < 0)
913 return log_error_errno(r, "Failed to create retry timer: %m");
63463bf0
ML
914
915 m->exhausted_servers = true;
916
917 /* Increase the polling interval */
918 if (m->poll_interval_usec < NTP_POLL_INTERVAL_MAX_SEC * USEC_PER_SEC)
919 m->poll_interval_usec *= 2;
920
921 return 0;
922 }
923
924 m->exhausted_servers = false;
925
874ff7bf 926 manager_set_server_name(m, f);
84e51726
LP
927 }
928
929 /* Tell the resolver to reread /etc/resolv.conf, in
930 * case it changed. */
931 res_init();
932
874ff7bf
LP
933 /* Flush out any previously resolved addresses */
934 server_name_flush_addresses(m->current_server_name);
935
936 log_debug("Resolving %s...", m->current_server_name->string);
937
84e51726 938 r = sd_resolve_getaddrinfo(m->resolve, &m->resolve_query, m->current_server_name->string, "123", &hints, manager_resolve_handler, m);
f647962d
MS
939 if (r < 0)
940 return log_error_errno(r, "Failed to create resolver: %m");
84e51726
LP
941
942 return 1;
943 }
944
945 r = manager_begin(m);
946 if (r < 0)
947 return r;
948
949 return 1;
950}
951
84e51726
LP
952void manager_disconnect(Manager *m) {
953 assert(m);
954
955 m->resolve_query = sd_resolve_query_unref(m->resolve_query);
956
957 m->event_timer = sd_event_source_unref(m->event_timer);
958
f89c4e15 959 manager_listen_stop(m);
84e51726
LP
960
961 m->event_clock_watch = sd_event_source_unref(m->event_clock_watch);
962 m->clock_watch_fd = safe_close(m->clock_watch_fd);
963
964 m->event_timeout = sd_event_source_unref(m->event_timeout);
965
966 sd_notifyf(false, "STATUS=Idle.");
967}
968
874ff7bf
LP
969void manager_flush_server_names(Manager *m, ServerType t) {
970 assert(m);
971
972 if (t == SERVER_SYSTEM)
973 while (m->system_servers)
974 server_name_free(m->system_servers);
975
976 if (t == SERVER_LINK)
977 while (m->link_servers)
978 server_name_free(m->link_servers);
979
980 if (t == SERVER_FALLBACK)
981 while (m->fallback_servers)
982 server_name_free(m->fallback_servers);
983}
84e51726
LP
984
985void manager_free(Manager *m) {
986 if (!m)
987 return;
988
989 manager_disconnect(m);
874ff7bf
LP
990 manager_flush_server_names(m, SERVER_SYSTEM);
991 manager_flush_server_names(m, SERVER_LINK);
992 manager_flush_server_names(m, SERVER_FALLBACK);
84e51726
LP
993
994 sd_event_source_unref(m->event_retry);
995
996 sd_event_source_unref(m->network_event_source);
997 sd_network_monitor_unref(m->network_monitor);
998
999 sd_resolve_unref(m->resolve);
1000 sd_event_unref(m->event);
1001
1002 free(m);
1003}
1004
874ff7bf
LP
1005static int manager_network_read_link_servers(Manager *m) {
1006 _cleanup_strv_free_ char **ntp = NULL;
1007 ServerName *n, *nx;
1008 char **i;
1009 int r;
1010
84e51726
LP
1011 assert(m);
1012
874ff7bf
LP
1013 r = sd_network_get_ntp(&ntp);
1014 if (r < 0)
1015 goto clear;
1016
1017 LIST_FOREACH(names, n, m->link_servers)
1018 n->marked = true;
1019
1020 STRV_FOREACH(i, ntp) {
1021 bool found = false;
1022
1023 LIST_FOREACH(names, n, m->link_servers)
1024 if (streq(n->string, *i)) {
1025 n->marked = false;
1026 found = true;
1027 break;
1028 }
1029
1030 if (!found) {
1031 r = server_name_new(m, NULL, SERVER_LINK, *i);
1032 if (r < 0)
1033 goto clear;
1034 }
1035 }
1036
1037 LIST_FOREACH_SAFE(names, n, nx, m->link_servers)
1038 if (n->marked)
1039 server_name_free(n);
1040
1041 return 0;
1042
1043clear:
1044 manager_flush_server_names(m, SERVER_LINK);
1045 return r;
84e51726
LP
1046}
1047
1048static int manager_network_event_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
1049 Manager *m = userdata;
1050 bool connected, online;
1051 int r;
1052
1053 assert(m);
1054
1055 sd_network_monitor_flush(m->network_monitor);
1056
874ff7bf
LP
1057 manager_network_read_link_servers(m);
1058
84e51726
LP
1059 /* check if the machine is online */
1060 online = network_is_online();
1061
1062 /* check if the client is currently connected */
63463bf0 1063 connected = m->server_socket >= 0 || m->resolve_query || m->exhausted_servers;
84e51726
LP
1064
1065 if (connected && !online) {
1066 log_info("No network connectivity, watching for changes.");
1067 manager_disconnect(m);
1068
1069 } else if (!connected && online) {
1070 log_info("Network configuration changed, trying to establish connection.");
1071
1072 if (m->current_server_address)
1073 r = manager_begin(m);
1074 else
1075 r = manager_connect(m);
1076 if (r < 0)
1077 return r;
1078 }
1079
1080 return 0;
1081}
1082
1083static int manager_network_monitor_listen(Manager *m) {
1084 int r, fd, events;
1085
1086 assert(m);
1087
1088 r = sd_network_monitor_new(&m->network_monitor, NULL);
1089 if (r < 0)
1090 return r;
1091
1092 fd = sd_network_monitor_get_fd(m->network_monitor);
1093 if (fd < 0)
1094 return fd;
1095
1096 events = sd_network_monitor_get_events(m->network_monitor);
1097 if (events < 0)
1098 return events;
1099
1100 r = sd_event_add_io(m->event, &m->network_event_source, fd, events, manager_network_event_handler, m);
1101 if (r < 0)
1102 return r;
1103
1104 return 0;
1105}
1106
1107int manager_new(Manager **ret) {
1108 _cleanup_(manager_freep) Manager *m = NULL;
1109 int r;
1110
1111 assert(ret);
1112
1113 m = new0(Manager, 1);
1114 if (!m)
1115 return -ENOMEM;
1116
1117 m->server_socket = m->clock_watch_fd = -1;
1118
1119 RATELIMIT_INIT(m->ratelimit, RATELIMIT_INTERVAL_USEC, RATELIMIT_BURST);
1120
874ff7bf 1121 r = manager_parse_server_string(m, SERVER_FALLBACK, NTP_SERVERS);
84e51726
LP
1122 if (r < 0)
1123 return r;
1124
1125 r = sd_event_default(&m->event);
1126 if (r < 0)
1127 return r;
1128
1129 sd_event_add_signal(m->event, NULL, SIGTERM, NULL, NULL);
1130 sd_event_add_signal(m->event, NULL, SIGINT, NULL, NULL);
1131
1132 sd_event_set_watchdog(m->event, true);
1133
1134 r = sd_resolve_default(&m->resolve);
1135 if (r < 0)
1136 return r;
1137
1138 r = sd_resolve_attach_event(m->resolve, m->event, 0);
1139 if (r < 0)
1140 return r;
1141
1142 r = manager_network_monitor_listen(m);
1143 if (r < 0)
1144 return r;
1145
c572db3c 1146 manager_network_read_link_servers(m);
874ff7bf 1147
84e51726
LP
1148 *ret = m;
1149 m = NULL;
1150
1151 return 0;
1152}