src/ntpd.c

   1 /**
   2  * collectd - src/ntpd.c
   3  * Copyright (C) 2006-2012  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #define _DEFAULT_SOURCE
  28 #define _BSD_SOURCE /* For NI_MAXHOST */
  29
  30 #include "collectd.h"
  31 #include "common.h"
  32 #include "plugin.h"
  33 #include "configfile.h"
  34
  35 #if HAVE_STDINT_H
  36 # include <stdint.h>
  37 #endif
  38 #if HAVE_NETDB_H
  39 # include <netdb.h>
  40 #endif
  41 #if HAVE_SYS_SOCKET_H
  42 # include <sys/socket.h>
  43 #endif
  44 #if HAVE_NETINET_IN_H
  45 # include <netinet/in.h>
  46 #endif
  47 #if HAVE_ARPA_INET_H
  48 # include <arpa/inet.h> /* inet_ntoa */
  49 #endif
  50 #if HAVE_NETINET_TCP_H
  51 # include <netinet/tcp.h>
  52 #endif
  53 #if HAVE_POLL_H
  54 # include <poll.h>
  55 #endif
  56
  57 static const char *config_keys[] =
  58 {
  59         "Host",
  60         "Port",
  61         "ReverseLookups",
  62         "IncludeUnitID"
  63 };
  64 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  65
  66 static _Bool do_reverse_lookups = 1;
  67
  68 /* This option only exists for backward compatibility. If it is false and two
  69  * ntpd peers use the same refclock driver, the plugin will try to write
  70  * simultaneous measurements from both to the same type instance. */
  71 static _Bool include_unit_id = 0;
  72
  73 # define NTPD_DEFAULT_HOST "localhost"
  74 # define NTPD_DEFAULT_PORT "123"
  75 static int   sock_descr = -1;
  76 static char *ntpd_host = NULL;
  77 static char  ntpd_port[16];
  78
  79 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  80  * The following definitions were copied from the NTPd distribution  *
  81  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  82 #define MAXFILENAME 128
  83 #define MAXSEQ  127
  84 #define MODE_PRIVATE 7
  85 #define NTP_OLDVERSION ((uint8_t) 1) /* oldest credible version */
  86 #define IMPL_XNTPD 3
  87 #define FP_FRAC 65536.0
  88
  89 #define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */
  90 #define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */
  91
  92 /* This structure is missing the message authentication code, since collectd
  93  * doesn't use it. */
  94 struct req_pkt
  95 {
  96         uint8_t  rm_vn_mode;
  97         uint8_t  auth_seq;
  98         uint8_t  implementation;                /* implementation number */
  99         uint8_t  request;                       /* request number */
 100         uint16_t err_nitems;            /* error code/number of data items */
 101         uint16_t mbz_itemsize;          /* item size */
 102         char     data[MAXFILENAME + 48];        /* data area [32 prev](176 byte max) */
 103                                         /* struct conf_peer must fit */
 104 };
 105 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
 106
 107 /*
 108  * A response packet.  The length here is variable, this is a
 109  * maximally sized one.  Note that this implementation doesn't
 110  * authenticate responses.
 111  */
 112 #define RESP_HEADER_SIZE        (8)
 113 #define RESP_DATA_SIZE          (500)
 114
 115 struct resp_pkt
 116 {
 117         uint8_t  rm_vn_mode;           /* response, more, version, mode */
 118         uint8_t  auth_seq;             /* key, sequence number */
 119         uint8_t  implementation;       /* implementation number */
 120         uint8_t  request;              /* request number */
 121         uint16_t err_nitems;           /* error code/number of data items */
 122         uint16_t mbz_itemsize;         /* item size */
 123         char     data[RESP_DATA_SIZE]; /* data area */
 124 };
 125
 126 /*
 127  * Bit setting macros for multifield items.
 128  */
 129 #define RESP_BIT        0x80
 130 #define MORE_BIT        0x40
 131
 132 #define ISRESPONSE(rm_vn_mode)  (((rm_vn_mode)&RESP_BIT)!=0)
 133 #define ISMORE(rm_vn_mode)      (((rm_vn_mode)&MORE_BIT)!=0)
 134 #define INFO_VERSION(rm_vn_mode) ((uint8_t)(((rm_vn_mode)>>3)&0x7))
 135 #define INFO_MODE(rm_vn_mode)   ((rm_vn_mode)&0x7)
 136
 137 #define RM_VN_MODE(resp, more, version)         \
 138                                 ((uint8_t)(((resp)?RESP_BIT:0)\
 139                                 |((more)?MORE_BIT:0)\
 140                                 |((version?version:(NTP_OLDVERSION+1))<<3)\
 141                                 |(MODE_PRIVATE)))
 142
 143 #define INFO_IS_AUTH(auth_seq)  (((auth_seq) & 0x80) != 0)
 144 #define INFO_SEQ(auth_seq)      ((auth_seq)&0x7f)
 145 #define AUTH_SEQ(auth, seq)     ((uint8_t)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
 146
 147 #define INFO_ERR(err_nitems)    ((uint16_t)((ntohs(err_nitems)>>12)&0xf))
 148 #define INFO_NITEMS(err_nitems) ((uint16_t)(ntohs(err_nitems)&0xfff))
 149 #define ERR_NITEMS(err, nitems) (htons((uint16_t)((((uint16_t)(err)<<12)&0xf000)\
 150                                 |((uint16_t)(nitems)&0xfff))))
 151
 152 #define INFO_MBZ(mbz_itemsize)  ((ntohs(mbz_itemsize)>>12)&0xf)
 153 #define INFO_ITEMSIZE(mbz_itemsize)     ((uint16_t)(ntohs(mbz_itemsize)&0xfff))
 154 #define MBZ_ITEMSIZE(itemsize)  (htons((uint16_t)(itemsize)))
 155
 156 /* negate a long float type */
 157 #define M_NEG(v_i, v_f) \
 158         do { \
 159                 if ((v_f) == 0) \
 160                 (v_i) = -((uint32_t)(v_i)); \
 161                 else { \
 162                         (v_f) = -((uint32_t)(v_f)); \
 163                         (v_i) = ~(v_i); \
 164                 } \
 165         } while(0)
 166 /* l_fp to double */
 167 #define M_LFPTOD(r_i, r_uf, d) \
 168         do { \
 169                 register int32_t  i; \
 170                 register uint32_t f; \
 171                 \
 172                 i = (r_i); \
 173                 f = (r_uf); \
 174                 if (i < 0) { \
 175                         M_NEG(i, f); \
 176                         (d) = -((double) i + ((double) f) / 4294967296.0); \
 177                 } else { \
 178                         (d) = (double) i + ((double) f) / 4294967296.0; \
 179                 } \
 180         } while (0)
 181
 182 #define REQ_PEER_LIST_SUM 1
 183 struct info_peer_summary
 184 {
 185         uint32_t dstadr;         /* local address (zero for undetermined) */
 186         uint32_t srcadr;         /* source address */
 187         uint16_t srcport;        /* source port */
 188         uint8_t stratum;         /* stratum of peer */
 189         int8_t hpoll;            /* host polling interval */
 190         int8_t ppoll;            /* peer polling interval */
 191         uint8_t reach;           /* reachability register */
 192         uint8_t flags;           /* flags, from above */
 193         uint8_t hmode;           /* peer mode */
 194         int32_t  delay;          /* peer.estdelay; s_fp */
 195         int32_t  offset_int;     /* peer.estoffset; integral part */
 196         int32_t  offset_frc;     /* peer.estoffset; fractional part */
 197         uint32_t dispersion;     /* peer.estdisp; u_fp */
 198         uint32_t v6_flag;        /* is this v6 or not */
 199         uint32_t unused1;        /* (unused) padding for dstadr6 */
 200         struct in6_addr dstadr6; /* local address (v6) */
 201         struct in6_addr srcadr6; /* source address (v6) */
 202 };
 203
 204 #define REQ_SYS_INFO 4
 205 struct info_sys
 206 {
 207         uint32_t peer;           /* system peer address (v4) */
 208         uint8_t  peer_mode;      /* mode we are syncing to peer in */
 209         uint8_t  leap;           /* system leap bits */
 210         uint8_t  stratum;        /* our stratum */
 211         int8_t   precision;      /* local clock precision */
 212         int32_t  rootdelay;      /* distance from sync source */
 213         uint32_t rootdispersion; /* dispersion from sync source */
 214         uint32_t refid;          /* reference ID of sync source */
 215         uint64_t reftime;        /* system reference time */
 216         uint32_t poll;           /* system poll interval */
 217         uint8_t  flags;          /* system flags */
 218         uint8_t  unused1;        /* unused */
 219         uint8_t  unused2;        /* unused */
 220         uint8_t  unused3;        /* unused */
 221         int32_t  bdelay;         /* default broadcast offset */
 222         int32_t  frequency;      /* frequency residual (scaled ppm)  */
 223         uint64_t authdelay;      /* default authentication delay */
 224         uint32_t stability;      /* clock stability (scaled ppm) */
 225         int32_t  v6_flag;        /* is this v6 or not */
 226         int32_t  unused4;        /* unused, padding for peer6 */
 227         struct in6_addr peer6;   /* system peer address (v6) */
 228 };
 229
 230 #define REQ_GET_KERNEL 38
 231 struct info_kernel
 232 {
 233         int32_t  offset;
 234         int32_t  freq;
 235         int32_t  maxerror;
 236         int32_t  esterror;
 237         uint16_t status;
 238         uint16_t shift;
 239         int32_t  constant;
 240         int32_t  precision;
 241         int32_t  tolerance;
 242         /* pps stuff */
 243         int32_t  ppsfreq;
 244         int32_t  jitter;
 245         int32_t  stabil;
 246         int32_t  jitcnt;
 247         int32_t  calcnt;
 248         int32_t  errcnt;
 249         int32_t  stbcnt;
 250 };
 251
 252 /* List of reference clock names */
 253 static char *refclock_names[] =
 254 {
 255         "UNKNOWN",    "LOCAL",        "GPS_TRAK",   "WWV_PST",     /*  0- 3 */
 256         "SPECTRACOM", "TRUETIME",     "IRIG_AUDIO", "CHU_AUDIO",   /*  4- 7 */
 257         "GENERIC",    "GPS_MX4200",   "GPS_AS2201", "GPS_ARBITER", /*  8-11 */
 258         "IRIG_TPRO",  "ATOM_LEITCH",  "MSF_EES",    "GPSTM_TRUE",  /* 12-15 */
 259         "GPS_BANC",   "GPS_DATUM",    "ACTS_NIST",  "WWV_HEATH",   /* 16-19 */
 260         "GPS_NMEA",   "GPS_VME",      "PPS",        "ACTS_PTB",    /* 20-23 */
 261         "ACTS_USNO",  "TRUETIME",     "GPS_HP",     "MSF_ARCRON",  /* 24-27 */
 262         "SHM",        "GPS_PALISADE", "GPS_ONCORE", "GPS_JUPITER", /* 28-31 */
 263         "CHRONOLOG",  "DUMBCLOCK",    "ULINK_M320", "PCF",         /* 32-35 */
 264         "WWV_AUDIO",  "GPS_FG",       "HOPF_S",     "HOPF_P",      /* 36-39 */
 265         "JJY",        "TT_IRIG",      "GPS_ZYFER",  "GPS_RIPENCC", /* 40-43 */
 266         "NEOCLK4X"                                                 /* 44    */
 267 };
 268 static int refclock_names_num = STATIC_ARRAY_SIZE (refclock_names);
 269 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 270  * End of the copied stuff..                                         *
 271  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 272
 273 static int ntpd_config (const char *key, const char *value)
 274 {
 275         if (strcasecmp (key, "Host") == 0)
 276         {
 277                 if (ntpd_host != NULL)
 278                         free (ntpd_host);
 279                 if ((ntpd_host = strdup (value)) == NULL)
 280                         return (1);
 281         }
 282         else if (strcasecmp (key, "Port") == 0)
 283         {
 284                 int port = (int) (atof (value));
 285                 if ((port > 0) && (port <= 65535))
 286                         ssnprintf (ntpd_port, sizeof (ntpd_port),
 287                                         "%i", port);
 288                 else
 289                         sstrncpy (ntpd_port, value, sizeof (ntpd_port));
 290         }
 291         else if (strcasecmp (key, "ReverseLookups") == 0)
 292         {
 293                 if (IS_TRUE (value))
 294                         do_reverse_lookups = 1;
 295                 else
 296                         do_reverse_lookups = 0;
 297         }
 298         else if (strcasecmp (key, "IncludeUnitID") == 0)
 299         {
 300                 if (IS_TRUE (value))
 301                         include_unit_id = 1;
 302                 else
 303                         include_unit_id = 0;
 304         }
 305         else
 306         {
 307                 return (-1);
 308         }
 309
 310         return (0);
 311 }
 312
 313 static void ntpd_submit (char *type, char *type_inst, double value)
 314 {
 315         value_t values[1];
 316         value_list_t vl = VALUE_LIST_INIT;
 317
 318         values[0].gauge = value;
 319
 320         vl.values = values;
 321         vl.values_len = 1;
 322         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 323         sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
 324         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
 325         sstrncpy (vl.type, type, sizeof (vl.type));
 326         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 327
 328         plugin_dispatch_values (&vl);
 329 }
 330
 331 /* Each time a peer is polled, ntpd shifts the reach register to the left and
 332  * sets the LSB based on whether the peer was reachable. If the LSB is zero,
 333  * the values are out of date. */
 334 static void ntpd_submit_reach (char *type, char *type_inst, uint8_t reach,
 335                 double value)
 336 {
 337         if (!(reach & 1))
 338                 value = NAN;
 339
 340         ntpd_submit (type, type_inst, value);
 341 }
 342
 343 static int ntpd_connect (void)
 344 {
 345         char *host;
 346         char *port;
 347
 348         struct addrinfo  ai_hints;
 349         struct addrinfo *ai_list;
 350         struct addrinfo *ai_ptr;
 351         int              status;
 352
 353         if (sock_descr >= 0)
 354                 return (sock_descr);
 355
 356         DEBUG ("Opening a new socket");
 357
 358         host = ntpd_host;
 359         if (host == NULL)
 360                 host = NTPD_DEFAULT_HOST;
 361
 362         port = ntpd_port;
 363         if (strlen (port) == 0)
 364                 port = NTPD_DEFAULT_PORT;
 365
 366         memset (&ai_hints, '\0', sizeof (ai_hints));
 367         ai_hints.ai_flags    = 0;
 368 #ifdef AI_ADDRCONFIG
 369         ai_hints.ai_flags   |= AI_ADDRCONFIG;
 370 #endif
 371         ai_hints.ai_family   = PF_UNSPEC;
 372         ai_hints.ai_socktype = SOCK_DGRAM;
 373         ai_hints.ai_protocol = IPPROTO_UDP;
 374
 375         if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
 376         {
 377                 char errbuf[1024];
 378                 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
 379                                 host, port,
 380                                 (status == EAI_SYSTEM)
 381                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 382                                 : gai_strerror (status));
 383                 return (-1);
 384         }
 385
 386         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 387         {
 388                 /* create our socket descriptor */
 389                 if ((sock_descr = socket (ai_ptr->ai_family,
 390                                                 ai_ptr->ai_socktype,
 391                                                 ai_ptr->ai_protocol)) < 0)
 392                         continue;
 393
 394                 /* connect to the ntpd */
 395                 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
 396                 {
 397                         close (sock_descr);
 398                         sock_descr = -1;
 399                         continue;
 400                 }
 401
 402                 break;
 403         }
 404
 405         freeaddrinfo (ai_list);
 406
 407         if (sock_descr < 0)
 408         {
 409                 ERROR ("ntpd plugin: Unable to connect to server.");
 410         }
 411
 412         return (sock_descr);
 413 }
 414
 415 /* For a description of the arguments see `ntpd_do_query' below. */
 416 static int ntpd_receive_response (int *res_items, int *res_size,
 417                 char **res_data, int res_item_size)
 418 {
 419         int              sd;
 420         struct pollfd    poll_s;
 421         struct resp_pkt  res;
 422         int              status;
 423         int              done;
 424         int              i;
 425
 426         char            *items;
 427         size_t           items_num;
 428
 429         struct timeval   time_end;
 430         struct timeval   time_now;
 431         int              timeout;
 432
 433         int              pkt_item_num;        /* items in this packet */
 434         int              pkt_item_len;        /* size of the items in this packet */
 435         int              pkt_sequence;
 436         char             pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
 437         int              pkt_recvd_num;       /* number of packets that have been received */
 438         int              pkt_lastseq;         /* the last sequence number */
 439         ssize_t          pkt_padding;         /* Padding in this packet */
 440
 441         if ((sd = ntpd_connect ()) < 0)
 442                 return (-1);
 443
 444         items = NULL;
 445         items_num = 0;
 446
 447         memset (pkt_recvd, '\0', sizeof (pkt_recvd));
 448         pkt_recvd_num = 0;
 449         pkt_lastseq   = -1;
 450
 451         *res_items = 0;
 452         *res_size  = 0;
 453         *res_data  = NULL;
 454
 455         if (gettimeofday (&time_end, NULL) < 0)
 456         {
 457                 char errbuf[1024];
 458                 ERROR ("ntpd plugin: gettimeofday failed: %s",
 459                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 460                 return (-1);
 461         }
 462         time_end.tv_sec++; /* wait for a most one second */
 463
 464         done = 0;
 465         while (done == 0)
 466         {
 467                 struct timeval time_left;
 468
 469                 if (gettimeofday (&time_now, NULL) < 0)
 470                 {
 471                         char errbuf[1024];
 472                         ERROR ("ntpd plugin: gettimeofday failed: %s",
 473                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 474                         return (-1);
 475                 }
 476
 477                 if (timeval_cmp (time_end, time_now, &time_left) <= 0)
 478                         timeout = 0;
 479                 else
 480                         timeout = 1000 * time_left.tv_sec
 481                                 + ((time_left.tv_usec + 500) / 1000);
 482
 483                 /* timeout reached */
 484                 if (timeout <= 0)
 485                         break;
 486
 487                 poll_s.fd      = sd;
 488                 poll_s.events  = POLLIN | POLLPRI;
 489                 poll_s.revents = 0;
 490
 491                 DEBUG ("Polling for %ims", timeout);
 492                 status = poll (&poll_s, 1, timeout);
 493
 494                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
 495                         continue;
 496
 497                 if (status < 0)
 498                 {
 499                         char errbuf[1024];
 500                         ERROR ("ntpd plugin: poll failed: %s",
 501                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 502                         return (-1);
 503                 }
 504
 505                 if (status == 0) /* timeout */
 506                 {
 507                         DEBUG ("timeout reached.");
 508                         break;
 509                 }
 510
 511                 memset ((void *) &res, '\0', sizeof (res));
 512                 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
 513
 514                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
 515                         continue;
 516
 517                 if (status < 0)
 518                 {
 519                         char errbuf[1024];
 520                         INFO ("recv(2) failed: %s",
 521                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 522                         DEBUG ("Closing socket #%i", sd);
 523                         close (sd);
 524                         sock_descr = sd = -1;
 525                         return (-1);
 526                 }
 527
 528                 DEBUG ("recv'd %i bytes", status);
 529
 530                 /*
 531                  * Do some sanity checks first
 532                  */
 533                 if (status < RESP_HEADER_SIZE)
 534                 {
 535                         WARNING ("ntpd plugin: Short (%i bytes) packet received",
 536                                         (int) status);
 537                         continue;
 538                 }
 539                 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
 540                 {
 541                         NOTICE ("ntpd plugin: Packet received with mode %i",
 542                                         INFO_MODE (res.rm_vn_mode));
 543                         continue;
 544                 }
 545                 if (INFO_IS_AUTH (res.auth_seq))
 546                 {
 547                         NOTICE ("ntpd plugin: Encrypted packet received");
 548                         continue;
 549                 }
 550                 if (!ISRESPONSE (res.rm_vn_mode))
 551                 {
 552                         NOTICE ("ntpd plugin: Received request packet, "
 553                                         "wanted response");
 554                         continue;
 555                 }
 556                 if (INFO_MBZ (res.mbz_itemsize))
 557                 {
 558                         WARNING ("ntpd plugin: Received packet with nonzero "
 559                                         "MBZ field!");
 560                         continue;
 561                 }
 562                 if (res.implementation != IMPL_XNTPD)
 563                 {
 564                         WARNING ("ntpd plugin: Asked for request of type %i, "
 565                                         "got %i", (int) IMPL_XNTPD, (int) res.implementation);
 566                         continue;
 567                 }
 568
 569                 /* Check for error code */
 570                 if (INFO_ERR (res.err_nitems) != 0)
 571                 {
 572                         ERROR ("ntpd plugin: Received error code %i",
 573                                         (int) INFO_ERR(res.err_nitems));
 574                         return ((int) INFO_ERR (res.err_nitems));
 575                 }
 576
 577                 /* extract number of items in this packet and the size of these items */
 578                 pkt_item_num = INFO_NITEMS (res.err_nitems);
 579                 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
 580                 DEBUG ("pkt_item_num = %i; pkt_item_len = %i;",
 581                                 pkt_item_num, pkt_item_len);
 582
 583                 /* Check if the reported items fit in the packet */
 584                 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
 585                 {
 586                         ERROR ("ntpd plugin: %i items * %i bytes > "
 587                                         "%i bytes - %i bytes header",
 588                                         (int) pkt_item_num, (int) pkt_item_len,
 589                                         (int) status, (int) RESP_HEADER_SIZE);
 590                         continue;
 591                 }
 592
 593                 if (pkt_item_len > res_item_size)
 594                 {
 595                         ERROR ("ntpd plugin: (pkt_item_len = %i) "
 596                                         ">= (res_item_size = %i)",
 597                                         pkt_item_len, res_item_size);
 598                         continue;
 599                 }
 600
 601                 /* If this is the first packet (time wise, not sequence wise),
 602                  * set `res_size'. If it's not the first packet check if the
 603                  * items have the same size. Discard invalid packets. */
 604                 if (items_num == 0) /* first packet */
 605                 {
 606                         DEBUG ("*res_size = %i", pkt_item_len);
 607                         *res_size = pkt_item_len;
 608                 }
 609                 else if (*res_size != pkt_item_len)
 610                 {
 611                         DEBUG ("Error: *res_size = %i; pkt_item_len = %i;",
 612                                         *res_size, pkt_item_len);
 613                         ERROR ("Item sizes differ.");
 614                         continue;
 615                 }
 616
 617                 /*
 618                  * Because the items in the packet may be smaller than the
 619                  * items requested, the following holds true:
 620                  */
 621                 assert ((*res_size == pkt_item_len)
 622                                 && (pkt_item_len <= res_item_size));
 623
 624                 /* Calculate the padding. No idea why there might be any padding.. */
 625                 pkt_padding = 0;
 626                 if (pkt_item_len < res_item_size)
 627                         pkt_padding = res_item_size - pkt_item_len;
 628                 DEBUG ("res_item_size = %i; pkt_padding = %zi;",
 629                                 res_item_size, pkt_padding);
 630
 631                 /* Extract the sequence number */
 632                 pkt_sequence = INFO_SEQ (res.auth_seq);
 633                 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
 634                 {
 635                         ERROR ("ntpd plugin: Received packet with sequence %i",
 636                                         pkt_sequence);
 637                         continue;
 638                 }
 639
 640                 /* Check if this sequence has been received before. If so, discard it. */
 641                 if (pkt_recvd[pkt_sequence] != '\0')
 642                 {
 643                         NOTICE ("ntpd plugin: Sequence %i received twice",
 644                                         pkt_sequence);
 645                         continue;
 646                 }
 647
 648                 /* If `pkt_lastseq != -1' another packet without `more bit' has
 649                  * been received. */
 650                 if (!ISMORE (res.rm_vn_mode))
 651                 {
 652                         if (pkt_lastseq != -1)
 653                         {
 654                                 ERROR ("ntpd plugin: Two packets which both "
 655                                                 "claim to be the last one in the "
 656                                                 "sequence have been received.");
 657                                 continue;
 658                         }
 659                         pkt_lastseq = pkt_sequence;
 660                         DEBUG ("Last sequence = %i;", pkt_lastseq);
 661                 }
 662
 663                 /*
 664                  * Enough with the checks. Copy the data now.
 665                  * We start by allocating some more memory.
 666                  */
 667                 DEBUG ("realloc (%p, %zu)", (void *) *res_data,
 668                                 (items_num + pkt_item_num) * res_item_size);
 669                 items = realloc ((void *) *res_data,
 670                                 (items_num + pkt_item_num) * res_item_size);
 671                 if (items == NULL)
 672                 {
 673                         items = *res_data;
 674                         ERROR ("ntpd plugin: realloc failed.");
 675                         continue;
 676                 }
 677                 items_num += pkt_item_num;
 678                 *res_data = items;
 679
 680                 for (i = 0; i < pkt_item_num; i++)
 681                 {
 682                         /* dst: There are already `*res_items' items with
 683                          *      res_item_size bytes each in in `*res_data'. Set
 684                          *      dst to the first byte after that. */
 685                         void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
 686                         /* src: We use `pkt_item_len' to calculate the offset
 687                          *      from the beginning of the packet, because the
 688                          *      items in the packet may be smaller than the
 689                          *      items that were requested. We skip `i' such
 690                          *      items. */
 691                         void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
 692
 693                         /* Set the padding to zeros */
 694                         if (pkt_padding != 0)
 695                                 memset (dst, '\0', res_item_size);
 696                         memcpy (dst, src, (size_t) pkt_item_len);
 697
 698                         /* Increment `*res_items' by one, so `dst' will end up
 699                          * one further in the next round. */
 700                         (*res_items)++;
 701                 } /* for (pkt_item_num) */
 702
 703                 pkt_recvd[pkt_sequence] = (char) 1;
 704                 pkt_recvd_num++;
 705
 706                 if ((pkt_recvd_num - 1) == pkt_lastseq)
 707                         done = 1;
 708         } /* while (done == 0) */
 709
 710         return (0);
 711 } /* int ntpd_receive_response */
 712
 713 /* For a description of the arguments see `ntpd_do_query' below. */
 714 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
 715 {
 716         int             sd;
 717         struct req_pkt  req;
 718         size_t          req_data_len;
 719         int             status;
 720
 721         assert (req_items >= 0);
 722         assert (req_size  >= 0);
 723
 724         if ((sd = ntpd_connect ()) < 0)
 725                 return (-1);
 726
 727         memset ((void *) &req, '\0', sizeof (req));
 728         req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
 729         req.auth_seq   = AUTH_SEQ (0, 0);
 730         req.implementation = IMPL_XNTPD;
 731         req.request = (unsigned char) req_code;
 732
 733         req_data_len = (size_t) (req_items * req_size);
 734
 735         assert (((req_data != NULL) && (req_data_len > 0))
 736                         || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
 737
 738         req.err_nitems   = ERR_NITEMS (0, req_items);
 739         req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
 740
 741         if (req_data != NULL)
 742                 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
 743
 744         DEBUG ("req_items = %i; req_size = %i; req_data = %p;",
 745                         req_items, req_size, (void *) req_data);
 746
 747         status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
 748         if (status < 0)
 749         {
 750                 DEBUG ("`swrite' failed. Closing socket #%i", sd);
 751                 close (sd);
 752                 sock_descr = sd = -1;
 753                 return (status);
 754         }
 755
 756         return (0);
 757 }
 758
 759 /*
 760  * ntpd_do_query:
 761  *
 762  * req_code:      Type of request packet
 763  * req_items:     Numver of items in the request
 764  * req_size:      Size of one item in the request
 765  * req_data:      Data of the request packet
 766  * res_items:     Pointer to where the number returned items will be stored.
 767  * res_size:      Pointer to where the size of one returned item will be stored.
 768  * res_data:      This is where a pointer to the (allocated) data will be stored.
 769  * res_item_size: Size of one returned item. (used to calculate padding)
 770  *
 771  * returns:       zero upon success, non-zero otherwise.
 772  */
 773 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
 774                 int *res_items, int *res_size, char **res_data, int res_item_size)
 775 {
 776         int status;
 777
 778         status = ntpd_send_request (req_code, req_items, req_size, req_data);
 779         if (status != 0)
 780                 return (status);
 781
 782         status = ntpd_receive_response (res_items, res_size, res_data,
 783                         res_item_size);
 784         return (status);
 785 }
 786
 787 static double ntpd_read_fp (int32_t val_int)
 788 {
 789         double val_double;
 790
 791         val_int = ntohl (val_int);
 792         val_double = ((double) val_int) / FP_FRAC;
 793
 794         return (val_double);
 795 }
 796
 797 static uint32_t ntpd_get_refclock_id (struct info_peer_summary const *peer_info)
 798 {
 799         uint32_t addr = ntohl (peer_info->srcadr);
 800         uint32_t refclock_id = (addr >> 8) & 0x00FF;
 801
 802         return (refclock_id);
 803 }
 804
 805 static int ntpd_get_name_from_address (char *buffer, size_t buffer_size,
 806                 struct info_peer_summary const *peer_info, _Bool do_reverse_lookup)
 807 {
 808         struct sockaddr_storage sa;
 809         socklen_t sa_len;
 810         int flags = 0;
 811         int status;
 812
 813         memset (&sa, 0, sizeof (sa));
 814
 815         if (peer_info->v6_flag)
 816         {
 817                 struct sockaddr_in6 sa6;
 818
 819                 assert (sizeof (sa) >= sizeof (sa6));
 820
 821                 memset (&sa6, 0, sizeof (sa6));
 822                 sa6.sin6_family = AF_INET6;
 823                 sa6.sin6_port = htons (123);
 824                 memcpy (&sa6.sin6_addr, &peer_info->srcadr6,
 825                                 sizeof (struct in6_addr));
 826                 sa_len = sizeof (sa6);
 827
 828                 memcpy (&sa, &sa6, sizeof (sa6));
 829         }
 830         else
 831         {
 832                 struct sockaddr_in sa4;
 833
 834                 assert (sizeof (sa) >= sizeof (sa4));
 835
 836                 memset (&sa4, 0, sizeof (sa4));
 837                 sa4.sin_family = AF_INET;
 838                 sa4.sin_port = htons (123);
 839                 memcpy (&sa4.sin_addr, &peer_info->srcadr,
 840                                 sizeof (struct in_addr));
 841                 sa_len = sizeof (sa4);
 842
 843                 memcpy (&sa, &sa4, sizeof (sa4));
 844         }
 845
 846         if (!do_reverse_lookup)
 847                 flags |= NI_NUMERICHOST;
 848
 849         status = getnameinfo ((struct sockaddr const *) &sa, sa_len,
 850                         buffer, buffer_size,
 851                         NULL, 0, /* No port name */
 852                         flags);
 853         if (status != 0)
 854         {
 855                 char errbuf[1024];
 856                 ERROR ("ntpd plugin: getnameinfo failed: %s",
 857                                 (status == EAI_SYSTEM)
 858                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 859                                 : gai_strerror (status));
 860                 return (-1);
 861         }
 862
 863         return (0);
 864 } /* ntpd_get_name_from_address */
 865
 866 static int ntpd_get_name_refclock (char *buffer, size_t buffer_size,
 867                 struct info_peer_summary const *peer_info)
 868 {
 869         uint32_t refclock_id = ntpd_get_refclock_id (peer_info);
 870         uint32_t unit_id = ntohl (peer_info->srcadr) & 0x00FF;
 871
 872         if (refclock_id >= refclock_names_num)
 873                 return (ntpd_get_name_from_address (buffer, buffer_size,
 874                                         peer_info,
 875                                         /* do_reverse_lookup = */ 0));
 876
 877         if (include_unit_id)
 878                 ssnprintf (buffer, buffer_size, "%s-%"PRIu32,
 879                                 refclock_names[refclock_id], unit_id);
 880         else
 881                 sstrncpy (buffer, refclock_names[refclock_id], buffer_size);
 882
 883         return (0);
 884 } /* int ntpd_get_name_refclock */
 885
 886 static int ntpd_get_name (char *buffer, size_t buffer_size,
 887                 struct info_peer_summary const *peer_info)
 888 {
 889         uint32_t addr = ntohl (peer_info->srcadr);
 890
 891         if (!peer_info->v6_flag && ((addr & REFCLOCK_MASK) == REFCLOCK_ADDR))
 892                 return (ntpd_get_name_refclock (buffer, buffer_size,
 893                                         peer_info));
 894         else
 895                 return (ntpd_get_name_from_address (buffer, buffer_size,
 896                                         peer_info, do_reverse_lookups));
 897 } /* int ntpd_addr_to_name */
 898
 899 static int ntpd_read (void)
 900 {
 901         struct info_kernel *ik;
 902         int                 ik_num;
 903         int                 ik_size;
 904
 905         struct info_peer_summary *ps;
 906         int                       ps_num;
 907         int                       ps_size;
 908
 909         int status;
 910         int i;
 911
 912         ik      = NULL;
 913         ik_num  = 0;
 914         ik_size = 0;
 915
 916         status = ntpd_do_query (REQ_GET_KERNEL,
 917                         0, 0, NULL, /* request data */
 918                         &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
 919                         sizeof (struct info_kernel));
 920         if (status != 0)
 921         {
 922                 ERROR ("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", status);
 923                 return (status);
 924         }
 925         else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
 926         {
 927                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
 928                                 "(ik = %p; ik_num = %i; ik_size = %i)",
 929                                 (void *) ik, ik_num, ik_size);
 930                 return (-1);
 931         }
 932
 933         /* kerninfo -> estimated error */
 934
 935         DEBUG ("info_kernel:\n"
 936                         "  pll offset    = %.8f\n"
 937                         "  pll frequency = %.8f\n" /* drift compensation */
 938                         "  est error     = %.8f\n",
 939                         ntpd_read_fp (ik->offset),
 940                         ntpd_read_fp (ik->freq),
 941                         ntpd_read_fp (ik->esterror));
 942
 943         ntpd_submit ("frequency_offset", "loop",  ntpd_read_fp (ik->freq));
 944         ntpd_submit ("time_offset",      "loop",  ntpd_read_fp (ik->offset));
 945         ntpd_submit ("time_offset",      "error", ntpd_read_fp (ik->esterror));
 946
 947         free (ik);
 948         ik = NULL;
 949
 950         status = ntpd_do_query (REQ_PEER_LIST_SUM,
 951                         0, 0, NULL, /* request data */
 952                         &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
 953                         sizeof (struct info_peer_summary));
 954         if (status != 0)
 955         {
 956                 ERROR ("ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", status);
 957                 return (status);
 958         }
 959         else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
 960         {
 961                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
 962                                 "(ps = %p; ps_num = %i; ps_size = %i)",
 963                                 (void *) ps, ps_num, ps_size);
 964                 return (-1);
 965         }
 966
 967         for (i = 0; i < ps_num; i++)
 968         {
 969                 struct info_peer_summary *ptr;
 970                 double offset;
 971
 972                 char peername[NI_MAXHOST];
 973                 uint32_t refclock_id;
 974
 975                 ptr = ps + i;
 976
 977                 status = ntpd_get_name (peername, sizeof (peername), ptr);
 978                 if (status != 0)
 979                 {
 980                         ERROR ("ntpd plugin: Determining name of peer failed.");
 981                         continue;
 982                 }
 983
 984                 refclock_id = ntpd_get_refclock_id (ptr);
 985
 986                 /* Convert the `long floating point' offset value to double */
 987                 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
 988
 989                 DEBUG ("peer %i:\n"
 990                                 "  peername   = %s\n"
 991                                 "  srcadr     = 0x%08x\n"
 992                                 "  reach      = 0%03o\n"
 993                                 "  delay      = %f\n"
 994                                 "  offset_int = %i\n"
 995                                 "  offset_frc = %i\n"
 996                                 "  offset     = %f\n"
 997                                 "  dispersion = %f\n",
 998                                 i,
 999                                 peername,
1000                                 ntohl (ptr->srcadr),
1001                                 ptr->reach,
1002                                 ntpd_read_fp (ptr->delay),
1003                                 ntohl (ptr->offset_int),
1004                                 ntohl (ptr->offset_frc),
1005                                 offset,
1006                                 ntpd_read_fp (ptr->dispersion));
1007
1008                 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
1009                         ntpd_submit_reach ("time_offset", peername, ptr->reach,
1010                                         offset);
1011                 ntpd_submit_reach ("time_dispersion", peername, ptr->reach,
1012                                 ntpd_read_fp (ptr->dispersion));
1013                 if (refclock_id == 0) /* not a reference clock */
1014                         ntpd_submit_reach ("delay", peername, ptr->reach,
1015                                         ntpd_read_fp (ptr->delay));
1016         }
1017
1018         free (ps);
1019         ps = NULL;
1020
1021         return (0);
1022 } /* int ntpd_read */
1023
1024 void module_register (void)
1025 {
1026         plugin_register_config ("ntpd", ntpd_config,
1027                         config_keys, config_keys_num);
1028         plugin_register_read ("ntpd", ntpd_read);
1029 } /* void module_register */