ntp: Use mnemonics rather than magic numbers
[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 static guint channel_watch = 0;
103 static struct timeval transmit_timeval;
104 static int transmit_fd = 0;
105
106 static char *timeserver = NULL;
107 static gint poll_id = 0;
108 static gint timeout_id = 0;
109
110 static void send_packet(int fd, const char *server)
111 {
112         struct ntp_msg msg;
113         struct sockaddr_in addr;
114         ssize_t len;
115
116         memset(&msg, 0, sizeof(msg));
117         msg.flags = NTP_FLAGS_ENCODE(NTP_FLAG_LI_NOWARNING, 4, NTP_FLAG_MD_CLIENT);
118         msg.poll = 4;   // min
119         msg.poll = 10;  // max
120         msg.xmttime.seconds = random();
121         msg.xmttime.fraction = random();
122
123         memset(&addr, 0, sizeof(addr));
124         addr.sin_family = AF_INET;
125         addr.sin_port = htons(123);
126         addr.sin_addr.s_addr = inet_addr(server);
127
128         gettimeofday(&transmit_timeval, NULL);
129
130         len = sendto(fd, &msg, sizeof(msg), MSG_DONTWAIT,
131                                                 &addr, sizeof(addr));
132         if (len < 0) {
133                 connman_error("Time request for server %s failed (%d/%s)",
134                         server, errno, strerror(errno));
135
136                 if (errno == ENETUNREACH)
137                         __connman_timeserver_sync_next();
138
139                 return;
140         }
141
142         if (len != sizeof(msg)) {
143                 connman_error("Broken time request for server %s", server);
144                 return;
145         }
146 }
147
148 static gboolean next_server(gpointer user_data)
149 {
150         if (timeserver != NULL) {
151                 g_free(timeserver);
152                 timeserver = NULL;
153         }
154
155         __connman_timeserver_sync_next();
156
157         return FALSE;
158 }
159
160 static gboolean next_poll(gpointer user_data)
161 {
162         if (timeserver == NULL || transmit_fd == 0)
163                 return FALSE;
164
165         send_packet(transmit_fd, timeserver);
166
167         return FALSE;
168 }
169
170 static void decode_msg(void *base, size_t len, struct timeval *tv)
171 {
172         struct ntp_msg *msg = base;
173         double org, rec, xmt, dst;
174         double delay, offset;
175         static guint transmit_delay;
176
177         if (len < sizeof(*msg)) {
178                 connman_error("Invalid response from time server");
179                 return;
180         }
181
182         if (tv == NULL) {
183                 connman_error("Invalid packet timestamp from time server");
184                 return;
185         }
186
187         DBG("flags      : 0x%02x", msg->flags);
188         DBG("stratum    : %u", msg->stratum);
189         DBG("poll       : %f seconds (%d)",
190                                 LOGTOD(msg->poll), msg->poll);
191         DBG("precision  : %f seconds (%d)",
192                                 LOGTOD(msg->precision), msg->precision);
193         DBG("root delay : %u seconds (fraction %u)",
194                         msg->rootdelay.seconds, msg->rootdelay.fraction);
195         DBG("root disp. : %u seconds (fraction %u)",
196                         msg->rootdisp.seconds, msg->rootdisp.fraction);
197         DBG("reference  : 0x%04x", msg->refid);
198
199         transmit_delay = LOGTOD(msg->poll);
200
201         if (msg->flags != 0x24)
202                 return;
203
204         org = transmit_timeval.tv_sec +
205                         (1.0e-6 * transmit_timeval.tv_usec) + OFFSET_1900_1970;
206         rec = ntohl(msg->rectime.seconds) +
207                         ((double) ntohl(msg->rectime.fraction) / UINT_MAX);
208         xmt = ntohl(msg->xmttime.seconds) +
209                         ((double) ntohl(msg->xmttime.fraction) / UINT_MAX);
210         dst = tv->tv_sec + (1.0e-6 * tv->tv_usec) + OFFSET_1900_1970;
211
212         DBG("org=%f rec=%f xmt=%f dst=%f", org, rec, xmt, dst);
213
214         offset = ((rec - org) + (xmt - dst)) / 2;
215         delay = (dst - org) - (xmt - rec);
216
217         DBG("offset=%f delay=%f", offset, delay);
218
219         /* Remove the timeout, as timeserver has responded */
220         if (timeout_id > 0)
221                 g_source_remove(timeout_id);
222
223         /*
224          * Now poll the server every transmit_delay seconds
225          * for time correction.
226          */
227         if (poll_id > 0)
228                 g_source_remove(poll_id);
229
230         DBG("Timeserver %s, next sync in %d seconds", timeserver, transmit_delay);
231
232         poll_id = g_timeout_add_seconds(transmit_delay, next_poll, NULL);
233
234         connman_info("ntp: time slew %+.6f s", offset);
235
236         if (offset < STEPTIME_MIN_OFFSET && offset > -STEPTIME_MIN_OFFSET) {
237                 struct timeval adj;
238
239                 adj.tv_sec = (long) offset;
240                 adj.tv_usec = (offset - adj.tv_sec) * 1000000;
241
242                 DBG("adjusting time");
243
244                 if (adjtime(&adj, &adj) < 0) {
245                         connman_error("Failed to adjust time");
246                         return;
247                 }
248
249                 DBG("%lu seconds, %lu msecs", adj.tv_sec, adj.tv_usec);
250         } else {
251                 struct timeval cur;
252                 double dtime;
253
254                 gettimeofday(&cur, NULL);
255                 dtime = offset + cur.tv_sec + 1.0e-6 * cur.tv_usec;
256                 cur.tv_sec = (long) dtime;
257                 cur.tv_usec = (dtime - cur.tv_sec) * 1000000;
258
259                 DBG("setting time");
260
261                 if (settimeofday(&cur, NULL) < 0) {
262                         connman_error("Failed to set time");
263                         return;
264                 }
265
266                 DBG("%lu seconds, %lu msecs", cur.tv_sec, cur.tv_usec);
267         }
268 }
269
270 static gboolean received_data(GIOChannel *channel, GIOCondition condition,
271                                                         gpointer user_data)
272 {
273         unsigned char buf[128];
274         struct msghdr msg;
275         struct iovec iov;
276         struct cmsghdr *cmsg;
277         struct timeval *tv;
278         char aux[128];
279         ssize_t len;
280         int fd;
281
282         if (condition & (G_IO_HUP | G_IO_ERR | G_IO_NVAL)) {
283                 connman_error("Problem with timer server channel");
284                 channel_watch = 0;
285                 return FALSE;
286         }
287
288         fd = g_io_channel_unix_get_fd(channel);
289
290         iov.iov_base = buf;
291         iov.iov_len = sizeof(buf);
292
293         memset(&msg, 0, sizeof(msg));
294         msg.msg_iov = &iov;
295         msg.msg_iovlen = 1;
296         msg.msg_control = aux;
297         msg.msg_controllen = sizeof(aux);
298
299         len = recvmsg(fd, &msg, MSG_DONTWAIT);
300         if (len < 0)
301                 return TRUE;
302
303         tv = NULL;
304
305         for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
306                 if (cmsg->cmsg_level != SOL_SOCKET)
307                         continue;
308
309                 switch (cmsg->cmsg_type) {
310                 case SCM_TIMESTAMP:
311                         tv = (struct timeval *) CMSG_DATA(cmsg);
312                         break;
313                 }
314         }
315
316         decode_msg(iov.iov_base, iov.iov_len, tv);
317
318         return TRUE;
319 }
320
321 static void start_ntp(char *server)
322 {
323         GIOChannel *channel;
324         struct sockaddr_in addr;
325         int tos = IPTOS_LOWDELAY, timestamp = 1;
326
327         if (server == NULL)
328                 return;
329
330         DBG("server %s", server);
331
332         if (channel_watch > 0)
333                 goto send;
334
335         transmit_fd = socket(PF_INET, SOCK_DGRAM | SOCK_CLOEXEC, 0);
336         if (transmit_fd < 0) {
337                 connman_error("Failed to open time server socket");
338                 return;
339         }
340
341         memset(&addr, 0, sizeof(addr));
342         addr.sin_family = AF_INET;
343
344         if (bind(transmit_fd, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
345                 connman_error("Failed to bind time server socket");
346                 close(transmit_fd);
347                 return;
348         }
349
350         if (setsockopt(transmit_fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)) < 0) {
351                 connman_error("Failed to set type of service option");
352                 close(transmit_fd);
353                 return;
354         }
355
356         if (setsockopt(transmit_fd, SOL_SOCKET, SO_TIMESTAMP, &timestamp,
357                                                 sizeof(timestamp)) < 0) {
358                 connman_error("Failed to enable timestamp support");
359                 close(transmit_fd);
360                 return;
361         }
362
363         channel = g_io_channel_unix_new(transmit_fd);
364         if (channel == NULL) {
365                 close(transmit_fd);
366                 return;
367         }
368
369         g_io_channel_set_encoding(channel, NULL, NULL);
370         g_io_channel_set_buffered(channel, FALSE);
371
372         g_io_channel_set_close_on_unref(channel, TRUE);
373
374         channel_watch = g_io_add_watch_full(channel, G_PRIORITY_DEFAULT,
375                                 G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_NVAL,
376                                 received_data, NULL, NULL);
377
378         g_io_channel_unref(channel);
379
380 send:
381         send_packet(transmit_fd, server);
382 }
383
384 int __connman_ntp_start(char *server)
385 {
386         DBG("%s", server);
387
388         if (server == NULL)
389                 return -EINVAL;
390
391         if (timeserver != NULL)
392                 g_free(timeserver);
393
394         timeserver = g_strdup(server);
395
396         start_ntp(timeserver);
397
398         /*
399          * Add a fallback timeout , preferably short, 5 sec here,
400          * to fallback on the next server.
401          */
402
403         timeout_id = g_timeout_add_seconds(5, next_server, NULL);
404
405         return 0;
406 }
407
408 void __connman_ntp_stop()
409 {
410         DBG("");
411
412         if (poll_id > 0)
413                 g_source_remove(poll_id);
414
415         if (timeout_id > 0)
416                 g_source_remove(timeout_id);
417
418         if (channel_watch > 0) {
419                 g_source_remove(channel_watch);
420                 channel_watch = 0;
421                 transmit_fd = 0;
422         }
423
424         if (timeserver != NULL) {
425                 g_free(timeserver);
426                 timeserver = NULL;
427         }
428 }