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