ntp: Add mnemonics for common clock precisions
[platform/upstream/connman.git] / src / ntp.c
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2012  Intel Corporation. All rights reserved.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2 as
9  *  published by the Free Software Foundation.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #define _GNU_SOURCE
27 #include <errno.h>
28 #include <fcntl.h>
29 #include <unistd.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <sys/time.h>
33 #include <sys/socket.h>
34 #include <netinet/in.h>
35 #include <netinet/ip.h>
36 #include <arpa/inet.h>
37
38 #include <glib.h>
39
40 #include "connman.h"
41
42 struct ntp_short {
43         uint16_t seconds;
44         uint16_t fraction;
45 } __attribute__ ((packed));
46
47 struct ntp_time {
48         uint32_t seconds;
49         uint32_t fraction;
50 } __attribute__ ((packed));
51
52 struct ntp_msg {
53         uint8_t flags;                  /* Mode, version and leap indicator */
54         uint8_t stratum;                /* Stratum details */
55         int8_t poll;                    /* Maximum interval in log2 seconds */
56         int8_t precision;               /* Clock precision in log2 seconds */
57         struct ntp_short rootdelay;     /* Root delay */
58         struct ntp_short rootdisp;      /* Root dispersion */
59         uint32_t refid;                 /* Reference ID */
60         struct ntp_time reftime;        /* Reference timestamp */
61         struct ntp_time orgtime;        /* Origin timestamp */
62         struct ntp_time rectime;        /* Receive timestamp */
63         struct ntp_time xmttime;        /* Transmit timestamp */
64 } __attribute__ ((packed));
65
66 #define OFFSET_1900_1970  2208988800UL  /* 1970 - 1900 in seconds */
67
68 #define STEPTIME_MIN_OFFSET  0.128
69
70 #define LOGTOD(a)  ((a) < 0 ? 1. / (1L << -(a)) : 1L << (int)(a))
71
72 #define NTP_FLAG_LI_SHIFT      6
73 #define NTP_FLAG_LI_MASK       0x3
74 #define NTP_FLAG_LI_NOWARNING  0x0
75 #define NTP_FLAG_LI_ADDSECOND  0x1
76 #define NTP_FLAG_LI_DELSECOND  0x2
77 #define NTP_FLAG_LI_NOTINSYNC  0x3
78
79 #define NTP_FLAG_VN_SHIFT      3
80 #define NTP_FLAG_VN_MASK       0x7
81
82 #define NTP_FLAG_MD_SHIFT      0
83 #define NTP_FLAG_MD_MASK       0x7
84 #define NTP_FLAG_MD_UNSPEC     0
85 #define NTP_FLAG_MD_ACTIVE     1
86 #define NTP_FLAG_MD_PASSIVE    2
87 #define NTP_FLAG_MD_CLIENT     3
88 #define NTP_FLAG_MD_SERVER     4
89 #define NTP_FLAG_MD_BROADCAST  5
90 #define NTP_FLAG_MD_CONTROL    6
91 #define NTP_FLAG_MD_PRIVATE    7
92
93 #define NTP_FLAGS_ENCODE(li, vn, md)  ((uint8_t)( \
94                       (((li) & NTP_FLAG_LI_MASK) << NTP_FLAG_LI_SHIFT) | \
95                       (((vn) & NTP_FLAG_VN_MASK) << NTP_FLAG_VN_SHIFT) | \
96                       (((md) & NTP_FLAG_MD_MASK) << NTP_FLAG_MD_SHIFT)))
97
98 #define NTP_FLAGS_LI_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_LI_SHIFT) & NTP_FLAG_LI_MASK))
99 #define NTP_FLAGS_VN_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_VN_SHIFT) & NTP_FLAG_VN_MASK))
100 #define NTP_FLAGS_MD_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_MD_SHIFT) & NTP_FLAG_MD_MASK))
101
102 #define NTP_PRECISION_S    0
103 #define NTP_PRECISION_DS   -3
104 #define NTP_PRECISION_CS   -6
105 #define NTP_PRECISION_MS   -9
106 #define NTP_PRECISION_US   -19
107 #define NTP_PRECISION_NS   -29
108
109 static guint channel_watch = 0;
110 static struct timeval transmit_timeval;
111 static int transmit_fd = 0;
112
113 static char *timeserver = NULL;
114 static gint poll_id = 0;
115 static gint timeout_id = 0;
116
117 static void send_packet(int fd, const char *server)
118 {
119         struct ntp_msg msg;
120         struct sockaddr_in addr;
121         ssize_t len;
122
123         memset(&msg, 0, sizeof(msg));
124         msg.flags = NTP_FLAGS_ENCODE(NTP_FLAG_LI_NOTINSYNC, 4, NTP_FLAG_MD_CLIENT);
125         msg.poll = 4;   // min
126         msg.poll = 10;  // max
127
128         memset(&addr, 0, sizeof(addr));
129         addr.sin_family = AF_INET;
130         addr.sin_port = htons(123);
131         addr.sin_addr.s_addr = inet_addr(server);
132
133         gettimeofday(&transmit_timeval, NULL);
134
135         msg.xmttime.seconds = htonl(transmit_timeval.tv_sec + OFFSET_1900_1970);
136         msg.xmttime.fraction = htonl(transmit_timeval.tv_usec * 1000);
137
138         len = sendto(fd, &msg, sizeof(msg), MSG_DONTWAIT,
139                                                 &addr, sizeof(addr));
140         if (len < 0) {
141                 connman_error("Time request for server %s failed (%d/%s)",
142                         server, errno, strerror(errno));
143
144                 if (errno == ENETUNREACH)
145                         __connman_timeserver_sync_next();
146
147                 return;
148         }
149
150         if (len != sizeof(msg)) {
151                 connman_error("Broken time request for server %s", server);
152                 return;
153         }
154 }
155
156 static gboolean next_server(gpointer user_data)
157 {
158         if (timeserver != NULL) {
159                 g_free(timeserver);
160                 timeserver = NULL;
161         }
162
163         __connman_timeserver_sync_next();
164
165         return FALSE;
166 }
167
168 static gboolean next_poll(gpointer user_data)
169 {
170         if (timeserver == NULL || transmit_fd == 0)
171                 return FALSE;
172
173         send_packet(transmit_fd, timeserver);
174
175         return FALSE;
176 }
177
178 static void decode_msg(void *base, size_t len, struct timeval *tv)
179 {
180         struct ntp_msg *msg = base;
181         double org, rec, xmt, dst;
182         double delay, offset;
183         static guint transmit_delay;
184
185         if (len < sizeof(*msg)) {
186                 connman_error("Invalid response from time server");
187                 return;
188         }
189
190         if (tv == NULL) {
191                 connman_error("Invalid packet timestamp from time server");
192                 return;
193         }
194
195         DBG("flags      : 0x%02x", msg->flags);
196         DBG("stratum    : %u", msg->stratum);
197         DBG("poll       : %f seconds (%d)",
198                                 LOGTOD(msg->poll), msg->poll);
199         DBG("precision  : %f seconds (%d)",
200                                 LOGTOD(msg->precision), msg->precision);
201         DBG("root delay : %u seconds (fraction %u)",
202                         msg->rootdelay.seconds, msg->rootdelay.fraction);
203         DBG("root disp. : %u seconds (fraction %u)",
204                         msg->rootdisp.seconds, msg->rootdisp.fraction);
205         DBG("reference  : 0x%04x", msg->refid);
206
207         transmit_delay = LOGTOD(msg->poll);
208
209         if (NTP_FLAGS_LI_DECODE(msg->flags) == NTP_FLAG_LI_NOTINSYNC) {
210                 DBG("ignoring unsynchronized peer");
211                 return;
212         }
213
214         if (NTP_FLAGS_VN_DECODE(msg->flags) != 4) {
215                 DBG("unsupported version %d", NTP_FLAGS_VN_DECODE(msg->flags));
216                 return;
217         }
218
219         if (NTP_FLAGS_MD_DECODE(msg->flags) != NTP_FLAG_MD_SERVER) {
220                 DBG("unsupported mode %d", NTP_FLAGS_MD_DECODE(msg->flags));
221                 return;
222         }
223
224         org = transmit_timeval.tv_sec +
225                         (1.0e-6 * transmit_timeval.tv_usec) + OFFSET_1900_1970;
226         rec = ntohl(msg->rectime.seconds) +
227                         ((double) ntohl(msg->rectime.fraction) / UINT_MAX);
228         xmt = ntohl(msg->xmttime.seconds) +
229                         ((double) ntohl(msg->xmttime.fraction) / UINT_MAX);
230         dst = tv->tv_sec + (1.0e-6 * tv->tv_usec) + OFFSET_1900_1970;
231
232         DBG("org=%f rec=%f xmt=%f dst=%f", org, rec, xmt, dst);
233
234         offset = ((rec - org) + (xmt - dst)) / 2;
235         delay = (dst - org) - (xmt - rec);
236
237         DBG("offset=%f delay=%f", offset, delay);
238
239         /* Remove the timeout, as timeserver has responded */
240         if (timeout_id > 0)
241                 g_source_remove(timeout_id);
242
243         /*
244          * Now poll the server every transmit_delay seconds
245          * for time correction.
246          */
247         if (poll_id > 0)
248                 g_source_remove(poll_id);
249
250         DBG("Timeserver %s, next sync in %d seconds", timeserver, transmit_delay);
251
252         poll_id = g_timeout_add_seconds(transmit_delay, next_poll, NULL);
253
254         connman_info("ntp: time slew %+.6f s", offset);
255
256         if (offset < STEPTIME_MIN_OFFSET && offset > -STEPTIME_MIN_OFFSET) {
257                 struct timeval adj;
258
259                 adj.tv_sec = (long) offset;
260                 adj.tv_usec = (offset - adj.tv_sec) * 1000000;
261
262                 DBG("adjusting time");
263
264                 if (adjtime(&adj, &adj) < 0) {
265                         connman_error("Failed to adjust time");
266                         return;
267                 }
268
269                 DBG("%lu seconds, %lu msecs", adj.tv_sec, adj.tv_usec);
270         } else {
271                 struct timeval cur;
272                 double dtime;
273
274                 gettimeofday(&cur, NULL);
275                 dtime = offset + cur.tv_sec + 1.0e-6 * cur.tv_usec;
276                 cur.tv_sec = (long) dtime;
277                 cur.tv_usec = (dtime - cur.tv_sec) * 1000000;
278
279                 DBG("setting time");
280
281                 if (settimeofday(&cur, NULL) < 0) {
282                         connman_error("Failed to set time");
283                         return;
284                 }
285
286                 DBG("%lu seconds, %lu msecs", cur.tv_sec, cur.tv_usec);
287         }
288 }
289
290 static gboolean received_data(GIOChannel *channel, GIOCondition condition,
291                                                         gpointer user_data)
292 {
293         unsigned char buf[128];
294         struct msghdr msg;
295         struct iovec iov;
296         struct cmsghdr *cmsg;
297         struct timeval *tv;
298         char aux[128];
299         ssize_t len;
300         int fd;
301
302         if (condition & (G_IO_HUP | G_IO_ERR | G_IO_NVAL)) {
303                 connman_error("Problem with timer server channel");
304                 channel_watch = 0;
305                 return FALSE;
306         }
307
308         fd = g_io_channel_unix_get_fd(channel);
309
310         iov.iov_base = buf;
311         iov.iov_len = sizeof(buf);
312
313         memset(&msg, 0, sizeof(msg));
314         msg.msg_iov = &iov;
315         msg.msg_iovlen = 1;
316         msg.msg_control = aux;
317         msg.msg_controllen = sizeof(aux);
318
319         len = recvmsg(fd, &msg, MSG_DONTWAIT);
320         if (len < 0)
321                 return TRUE;
322
323         tv = NULL;
324
325         for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
326                 if (cmsg->cmsg_level != SOL_SOCKET)
327                         continue;
328
329                 switch (cmsg->cmsg_type) {
330                 case SCM_TIMESTAMP:
331                         tv = (struct timeval *) CMSG_DATA(cmsg);
332                         break;
333                 }
334         }
335
336         decode_msg(iov.iov_base, iov.iov_len, tv);
337
338         return TRUE;
339 }
340
341 static void start_ntp(char *server)
342 {
343         GIOChannel *channel;
344         struct sockaddr_in addr;
345         int tos = IPTOS_LOWDELAY, timestamp = 1;
346
347         if (server == NULL)
348                 return;
349
350         DBG("server %s", server);
351
352         if (channel_watch > 0)
353                 goto send;
354
355         transmit_fd = socket(PF_INET, SOCK_DGRAM | SOCK_CLOEXEC, 0);
356         if (transmit_fd < 0) {
357                 connman_error("Failed to open time server socket");
358                 return;
359         }
360
361         memset(&addr, 0, sizeof(addr));
362         addr.sin_family = AF_INET;
363
364         if (bind(transmit_fd, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
365                 connman_error("Failed to bind time server socket");
366                 close(transmit_fd);
367                 return;
368         }
369
370         if (setsockopt(transmit_fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)) < 0) {
371                 connman_error("Failed to set type of service option");
372                 close(transmit_fd);
373                 return;
374         }
375
376         if (setsockopt(transmit_fd, SOL_SOCKET, SO_TIMESTAMP, &timestamp,
377                                                 sizeof(timestamp)) < 0) {
378                 connman_error("Failed to enable timestamp support");
379                 close(transmit_fd);
380                 return;
381         }
382
383         channel = g_io_channel_unix_new(transmit_fd);
384         if (channel == NULL) {
385                 close(transmit_fd);
386                 return;
387         }
388
389         g_io_channel_set_encoding(channel, NULL, NULL);
390         g_io_channel_set_buffered(channel, FALSE);
391
392         g_io_channel_set_close_on_unref(channel, TRUE);
393
394         channel_watch = g_io_add_watch_full(channel, G_PRIORITY_DEFAULT,
395                                 G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_NVAL,
396                                 received_data, NULL, NULL);
397
398         g_io_channel_unref(channel);
399
400 send:
401         send_packet(transmit_fd, server);
402 }
403
404 int __connman_ntp_start(char *server)
405 {
406         DBG("%s", server);
407
408         if (server == NULL)
409                 return -EINVAL;
410
411         if (timeserver != NULL)
412                 g_free(timeserver);
413
414         timeserver = g_strdup(server);
415
416         start_ntp(timeserver);
417
418         /*
419          * Add a fallback timeout , preferably short, 5 sec here,
420          * to fallback on the next server.
421          */
422
423         timeout_id = g_timeout_add_seconds(5, next_server, NULL);
424
425         return 0;
426 }
427
428 void __connman_ntp_stop()
429 {
430         DBG("");
431
432         if (poll_id > 0)
433                 g_source_remove(poll_id);
434
435         if (timeout_id > 0)
436                 g_source_remove(timeout_id);
437
438         if (channel_watch > 0) {
439                 g_source_remove(channel_watch);
440                 channel_watch = 0;
441                 transmit_fd = 0;
442         }
443
444         if (timeserver != NULL) {
445                 g_free(timeserver);
446                 timeserver = NULL;
447         }
448 }