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_SEND_TIMEOUT       2
  73 #define NTP_SEND_RETRIES       3
  74
  75 #define NTP_FLAG_LI_SHIFT      6
  76 #define NTP_FLAG_LI_MASK       0x3
  77 #define NTP_FLAG_LI_NOWARNING  0x0
  78 #define NTP_FLAG_LI_ADDSECOND  0x1
  79 #define NTP_FLAG_LI_DELSECOND  0x2
  80 #define NTP_FLAG_LI_NOTINSYNC  0x3
  81
  82 #define NTP_FLAG_VN_SHIFT      3
  83 #define NTP_FLAG_VN_MASK       0x7
  84
  85 #define NTP_FLAG_MD_SHIFT      0
  86 #define NTP_FLAG_MD_MASK       0x7
  87 #define NTP_FLAG_MD_UNSPEC     0
  88 #define NTP_FLAG_MD_ACTIVE     1
  89 #define NTP_FLAG_MD_PASSIVE    2
  90 #define NTP_FLAG_MD_CLIENT     3
  91 #define NTP_FLAG_MD_SERVER     4
  92 #define NTP_FLAG_MD_BROADCAST  5
  93 #define NTP_FLAG_MD_CONTROL    6
  94 #define NTP_FLAG_MD_PRIVATE    7
  95
  96 #define NTP_FLAGS_ENCODE(li, vn, md)  ((uint8_t)( \
  97                       (((li) & NTP_FLAG_LI_MASK) << NTP_FLAG_LI_SHIFT) | \
  98                       (((vn) & NTP_FLAG_VN_MASK) << NTP_FLAG_VN_SHIFT) | \
  99                       (((md) & NTP_FLAG_MD_MASK) << NTP_FLAG_MD_SHIFT)))
 100
 101 #define NTP_FLAGS_LI_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_LI_SHIFT) & NTP_FLAG_LI_MASK))
 102 #define NTP_FLAGS_VN_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_VN_SHIFT) & NTP_FLAG_VN_MASK))
 103 #define NTP_FLAGS_MD_DECODE(flags)    ((uint8_t)(((flags) >> NTP_FLAG_MD_SHIFT) & NTP_FLAG_MD_MASK))
 104
 105 #define NTP_PRECISION_S    0
 106 #define NTP_PRECISION_DS   -3
 107 #define NTP_PRECISION_CS   -6
 108 #define NTP_PRECISION_MS   -9
 109 #define NTP_PRECISION_US   -19
 110 #define NTP_PRECISION_NS   -29
 111
 112 static guint channel_watch = 0;
 113 static struct timeval transmit_timeval;
 114 static int transmit_fd = 0;
 115
 116 static char *timeserver = NULL;
 117 static gint poll_id = 0;
 118 static gint timeout_id = 0;
 119 static guint retries = 0;
 120
 121 static void send_packet(int fd, const char *server);
 122
 123 static void next_server(void)
 124 {
 125         if (timeserver != NULL) {
 126                 g_free(timeserver);
 127                 timeserver = NULL;
 128         }
 129
 130         __connman_timeserver_sync_next();
 131 }
 132
 133 static gboolean send_timeout(gpointer user_data)
 134 {
 135         DBG("send timeout (retries %d)", retries);
 136
 137         if (retries++ == NTP_SEND_RETRIES)
 138                 next_server();
 139         else
 140                 send_packet(transmit_fd, timeserver);
 141
 142         return FALSE;
 143 }
 144
 145 static void send_packet(int fd, const char *server)
 146 {
 147         struct ntp_msg msg;
 148         struct sockaddr_in addr;
 149         ssize_t len;
 150
 151         /*
 152          * At some point, we could specify the actual system precision with:
 153          *
 154          *   clock_getres(CLOCK_REALTIME, &ts);
 155          *   msg.precision = (int)log2(ts.tv_sec + (ts.tv_nsec * 1.0e-9));
 156          */
 157         memset(&msg, 0, sizeof(msg));
 158         msg.flags = NTP_FLAGS_ENCODE(NTP_FLAG_LI_NOTINSYNC, 4, NTP_FLAG_MD_CLIENT);
 159         msg.poll = 4;   // min
 160         msg.poll = 10;  // max
 161         msg.precision = NTP_PRECISION_S;
 162
 163         memset(&addr, 0, sizeof(addr));
 164         addr.sin_family = AF_INET;
 165         addr.sin_port = htons(123);
 166         addr.sin_addr.s_addr = inet_addr(server);
 167
 168         gettimeofday(&transmit_timeval, NULL);
 169
 170         msg.xmttime.seconds = htonl(transmit_timeval.tv_sec + OFFSET_1900_1970);
 171         msg.xmttime.fraction = htonl(transmit_timeval.tv_usec * 1000);
 172
 173         len = sendto(fd, &msg, sizeof(msg), MSG_DONTWAIT,
 174                                                 &addr, sizeof(addr));
 175         if (len < 0) {
 176                 connman_error("Time request for server %s failed (%d/%s)",
 177                         server, errno, strerror(errno));
 178
 179                 if (errno == ENETUNREACH)
 180                         __connman_timeserver_sync_next();
 181
 182                 return;
 183         }
 184
 185         if (len != sizeof(msg)) {
 186                 connman_error("Broken time request for server %s", server);
 187                 return;
 188         }
 189
 190         /*
 191          * Add a retry timeout of two seconds to retry the existing
 192          * request. After a set number of retries, we'll fallback to
 193          * trying another server.
 194          */
 195
 196         timeout_id = g_timeout_add_seconds(NTP_SEND_TIMEOUT, send_timeout, NULL);
 197 }
 198
 199 static gboolean next_poll(gpointer user_data)
 200 {
 201         if (timeserver == NULL || transmit_fd == 0)
 202                 return FALSE;
 203
 204         send_packet(transmit_fd, timeserver);
 205
 206         return FALSE;
 207 }
 208
 209 static void reset_timeout(void)
 210 {
 211         if (timeout_id > 0)
 212                 g_source_remove(timeout_id);
 213
 214         retries = 0;
 215 }
 216
 217 static void decode_msg(void *base, size_t len, struct timeval *tv)
 218 {
 219         struct ntp_msg *msg = base;
 220         double org, rec, xmt, dst;
 221         double delay, offset;
 222         static guint transmit_delay;
 223
 224         if (len < sizeof(*msg)) {
 225                 connman_error("Invalid response from time server");
 226                 return;
 227         }
 228
 229         if (tv == NULL) {
 230                 connman_error("Invalid packet timestamp from time server");
 231                 return;
 232         }
 233
 234         DBG("flags      : 0x%02x", msg->flags);
 235         DBG("stratum    : %u", msg->stratum);
 236         DBG("poll       : %f seconds (%d)",
 237                                 LOGTOD(msg->poll), msg->poll);
 238         DBG("precision  : %f seconds (%d)",
 239                                 LOGTOD(msg->precision), msg->precision);
 240         DBG("root delay : %u seconds (fraction %u)",
 241                         msg->rootdelay.seconds, msg->rootdelay.fraction);
 242         DBG("root disp. : %u seconds (fraction %u)",
 243                         msg->rootdisp.seconds, msg->rootdisp.fraction);
 244         DBG("reference  : 0x%04x", msg->refid);
 245
 246         transmit_delay = LOGTOD(msg->poll);
 247
 248         if (NTP_FLAGS_LI_DECODE(msg->flags) == NTP_FLAG_LI_NOTINSYNC) {
 249                 DBG("ignoring unsynchronized peer");
 250                 return;
 251         }
 252
 253         if (NTP_FLAGS_VN_DECODE(msg->flags) != 4) {
 254                 DBG("unsupported version %d", NTP_FLAGS_VN_DECODE(msg->flags));
 255                 return;
 256         }
 257
 258         if (NTP_FLAGS_MD_DECODE(msg->flags) != NTP_FLAG_MD_SERVER) {
 259                 DBG("unsupported mode %d", NTP_FLAGS_MD_DECODE(msg->flags));
 260                 return;
 261         }
 262
 263         org = transmit_timeval.tv_sec +
 264                         (1.0e-6 * transmit_timeval.tv_usec) + OFFSET_1900_1970;
 265         rec = ntohl(msg->rectime.seconds) +
 266                         ((double) ntohl(msg->rectime.fraction) / UINT_MAX);
 267         xmt = ntohl(msg->xmttime.seconds) +
 268                         ((double) ntohl(msg->xmttime.fraction) / UINT_MAX);
 269         dst = tv->tv_sec + (1.0e-6 * tv->tv_usec) + OFFSET_1900_1970;
 270
 271         DBG("org=%f rec=%f xmt=%f dst=%f", org, rec, xmt, dst);
 272
 273         offset = ((rec - org) + (xmt - dst)) / 2;
 274         delay = (dst - org) - (xmt - rec);
 275
 276         DBG("offset=%f delay=%f", offset, delay);
 277
 278         /* Remove the timeout, as timeserver has responded */
 279
 280         reset_timeout();
 281
 282         /*
 283          * Now poll the server every transmit_delay seconds
 284          * for time correction.
 285          */
 286         if (poll_id > 0)
 287                 g_source_remove(poll_id);
 288
 289         DBG("Timeserver %s, next sync in %d seconds", timeserver, transmit_delay);
 290
 291         poll_id = g_timeout_add_seconds(transmit_delay, next_poll, NULL);
 292
 293         connman_info("ntp: time slew %+.6f s", offset);
 294
 295         if (offset < STEPTIME_MIN_OFFSET && offset > -STEPTIME_MIN_OFFSET) {
 296                 struct timeval adj;
 297
 298                 adj.tv_sec = (long) offset;
 299                 adj.tv_usec = (offset - adj.tv_sec) * 1000000;
 300
 301                 DBG("adjusting time");
 302
 303                 if (adjtime(&adj, &adj) < 0) {
 304                         connman_error("Failed to adjust time");
 305                         return;
 306                 }
 307
 308                 DBG("%lu seconds, %lu msecs", adj.tv_sec, adj.tv_usec);
 309         } else {
 310                 struct timeval cur;
 311                 double dtime;
 312
 313                 gettimeofday(&cur, NULL);
 314                 dtime = offset + cur.tv_sec + 1.0e-6 * cur.tv_usec;
 315                 cur.tv_sec = (long) dtime;
 316                 cur.tv_usec = (dtime - cur.tv_sec) * 1000000;
 317
 318                 DBG("setting time");
 319
 320                 if (settimeofday(&cur, NULL) < 0) {
 321                         connman_error("Failed to set time");
 322                         return;
 323                 }
 324
 325                 DBG("%lu seconds, %lu msecs", cur.tv_sec, cur.tv_usec);
 326         }
 327 }
 328
 329 static gboolean received_data(GIOChannel *channel, GIOCondition condition,
 330                                                         gpointer user_data)
 331 {
 332         unsigned char buf[128];
 333         struct msghdr msg;
 334         struct iovec iov;
 335         struct cmsghdr *cmsg;
 336         struct timeval *tv;
 337         char aux[128];
 338         ssize_t len;
 339         int fd;
 340
 341         if (condition & (G_IO_HUP | G_IO_ERR | G_IO_NVAL)) {
 342                 connman_error("Problem with timer server channel");
 343                 channel_watch = 0;
 344                 return FALSE;
 345         }
 346
 347         fd = g_io_channel_unix_get_fd(channel);
 348
 349         iov.iov_base = buf;
 350         iov.iov_len = sizeof(buf);
 351
 352         memset(&msg, 0, sizeof(msg));
 353         msg.msg_iov = &iov;
 354         msg.msg_iovlen = 1;
 355         msg.msg_control = aux;
 356         msg.msg_controllen = sizeof(aux);
 357
 358         len = recvmsg(fd, &msg, MSG_DONTWAIT);
 359         if (len < 0)
 360                 return TRUE;
 361
 362         tv = NULL;
 363
 364         for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
 365                 if (cmsg->cmsg_level != SOL_SOCKET)
 366                         continue;
 367
 368                 switch (cmsg->cmsg_type) {
 369                 case SCM_TIMESTAMP:
 370                         tv = (struct timeval *) CMSG_DATA(cmsg);
 371                         break;
 372                 }
 373         }
 374
 375         decode_msg(iov.iov_base, iov.iov_len, tv);
 376
 377         return TRUE;
 378 }
 379
 380 static void start_ntp(char *server)
 381 {
 382         GIOChannel *channel;
 383         struct sockaddr_in addr;
 384         int tos = IPTOS_LOWDELAY, timestamp = 1;
 385
 386         if (server == NULL)
 387                 return;
 388
 389         DBG("server %s", server);
 390
 391         if (channel_watch > 0)
 392                 goto send;
 393
 394         transmit_fd = socket(PF_INET, SOCK_DGRAM | SOCK_CLOEXEC, 0);
 395         if (transmit_fd < 0) {
 396                 connman_error("Failed to open time server socket");
 397                 return;
 398         }
 399
 400         memset(&addr, 0, sizeof(addr));
 401         addr.sin_family = AF_INET;
 402
 403         if (bind(transmit_fd, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
 404                 connman_error("Failed to bind time server socket");
 405                 close(transmit_fd);
 406                 return;
 407         }
 408
 409         if (setsockopt(transmit_fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)) < 0) {
 410                 connman_error("Failed to set type of service option");
 411                 close(transmit_fd);
 412                 return;
 413         }
 414
 415         if (setsockopt(transmit_fd, SOL_SOCKET, SO_TIMESTAMP, &timestamp,
 416                                                 sizeof(timestamp)) < 0) {
 417                 connman_error("Failed to enable timestamp support");
 418                 close(transmit_fd);
 419                 return;
 420         }
 421
 422         channel = g_io_channel_unix_new(transmit_fd);
 423         if (channel == NULL) {
 424                 close(transmit_fd);
 425                 return;
 426         }
 427
 428         g_io_channel_set_encoding(channel, NULL, NULL);
 429         g_io_channel_set_buffered(channel, FALSE);
 430
 431         g_io_channel_set_close_on_unref(channel, TRUE);
 432
 433         channel_watch = g_io_add_watch_full(channel, G_PRIORITY_DEFAULT,
 434                                 G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_NVAL,
 435                                 received_data, NULL, NULL);
 436
 437         g_io_channel_unref(channel);
 438
 439 send:
 440         send_packet(transmit_fd, server);
 441 }
 442
 443 int __connman_ntp_start(char *server)
 444 {
 445         DBG("%s", server);
 446
 447         if (server == NULL)
 448                 return -EINVAL;
 449
 450         if (timeserver != NULL)
 451                 g_free(timeserver);
 452
 453         timeserver = g_strdup(server);
 454
 455         start_ntp(timeserver);
 456
 457         return 0;
 458 }
 459
 460 void __connman_ntp_stop()
 461 {
 462         DBG("");
 463
 464         if (poll_id > 0)
 465                 g_source_remove(poll_id);
 466
 467         reset_timeout();
 468
 469         if (channel_watch > 0) {
 470                 g_source_remove(channel_watch);
 471                 channel_watch = 0;
 472                 transmit_fd = 0;
 473         }
 474
 475         if (timeserver != NULL) {
 476                 g_free(timeserver);
 477                 timeserver = NULL;
 478         }
 479 }