src/ntpd.c

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