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 (IS_TRUE (value))
 282                         do_reverse_lookups = 1;
 283                 else
 284                         do_reverse_lookups = 0;
 285         }
 286         else
 287         {
 288                 return (-1);
 289         }
 290
 291         return (0);
 292 }
 293
 294 static void ntpd_submit (char *type, char *type_inst, double value)
 295 {
 296         value_t values[1];
 297         value_list_t vl = VALUE_LIST_INIT;
 298
 299         values[0].gauge = value;
 300
 301         vl.values = values;
 302         vl.values_len = 1;
 303         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 304         sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
 305         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
 306         sstrncpy (vl.type, type, sizeof (vl.type));
 307         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 308
 309         plugin_dispatch_values (&vl);
 310 }
 311
 312 static int ntpd_connect (void)
 313 {
 314         char *host;
 315         char *port;
 316
 317         struct addrinfo  ai_hints;
 318         struct addrinfo *ai_list;
 319         struct addrinfo *ai_ptr;
 320         int              status;
 321
 322         if (sock_descr >= 0)
 323                 return (sock_descr);
 324
 325         DEBUG ("Opening a new socket");
 326
 327         host = ntpd_host;
 328         if (host == NULL)
 329                 host = NTPD_DEFAULT_HOST;
 330
 331         port = ntpd_port;
 332         if (strlen (port) == 0)
 333                 port = NTPD_DEFAULT_PORT;
 334
 335         memset (&ai_hints, '\0', sizeof (ai_hints));
 336         ai_hints.ai_flags    = 0;
 337 #ifdef AI_ADDRCONFIG
 338         ai_hints.ai_flags   |= AI_ADDRCONFIG;
 339 #endif
 340         ai_hints.ai_family   = PF_UNSPEC;
 341         ai_hints.ai_socktype = SOCK_DGRAM;
 342         ai_hints.ai_protocol = IPPROTO_UDP;
 343
 344         if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
 345         {
 346                 char errbuf[1024];
 347                 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
 348                                 host, port,
 349                                 (status == EAI_SYSTEM)
 350                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 351                                 : gai_strerror (status));
 352                 return (-1);
 353         }
 354
 355         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 356         {
 357                 /* create our socket descriptor */
 358                 if ((sock_descr = socket (ai_ptr->ai_family,
 359                                                 ai_ptr->ai_socktype,
 360                                                 ai_ptr->ai_protocol)) < 0)
 361                         continue;
 362
 363                 /* connect to the ntpd */
 364                 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
 365                 {
 366                         close (sock_descr);
 367                         sock_descr = -1;
 368                         continue;
 369                 }
 370
 371                 break;
 372         }
 373
 374         freeaddrinfo (ai_list);
 375
 376         if (sock_descr < 0)
 377         {
 378                 ERROR ("ntpd plugin: Unable to connect to server.");
 379         }
 380
 381         return (sock_descr);
 382 }
 383
 384 /* For a description of the arguments see `ntpd_do_query' below. */
 385 static int ntpd_receive_response (int *res_items, int *res_size,
 386                 char **res_data, int res_item_size)
 387 {
 388         int              sd;
 389         struct pollfd    poll_s;
 390         struct resp_pkt  res;
 391         int              status;
 392         int              done;
 393         int              i;
 394
 395         char            *items;
 396         size_t           items_num;
 397
 398         struct timeval   time_end;
 399         struct timeval   time_now;
 400         int              timeout;
 401
 402         int              pkt_item_num;        /* items in this packet */
 403         int              pkt_item_len;        /* size of the items in this packet */
 404         int              pkt_sequence;
 405         char             pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
 406         int              pkt_recvd_num;       /* number of packets that have been received */
 407         int              pkt_lastseq;         /* the last sequence number */
 408         ssize_t          pkt_padding;         /* Padding in this packet */
 409
 410         if ((sd = ntpd_connect ()) < 0)
 411                 return (-1);
 412
 413         items = NULL;
 414         items_num = 0;
 415
 416         memset (pkt_recvd, '\0', sizeof (pkt_recvd));
 417         pkt_recvd_num = 0;
 418         pkt_lastseq   = -1;
 419
 420         *res_items = 0;
 421         *res_size  = 0;
 422         *res_data  = NULL;
 423
 424         if (gettimeofday (&time_end, NULL) < 0)
 425         {
 426                 char errbuf[1024];
 427                 ERROR ("ntpd plugin: gettimeofday failed: %s",
 428                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 429                 return (-1);
 430         }
 431         time_end.tv_sec++; /* wait for a most one second */
 432
 433         done = 0;
 434         while (done == 0)
 435         {
 436                 struct timeval time_left;
 437
 438                 if (gettimeofday (&time_now, NULL) < 0)
 439                 {
 440                         char errbuf[1024];
 441                         ERROR ("ntpd plugin: gettimeofday failed: %s",
 442                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 443                         return (-1);
 444                 }
 445
 446                 if (timeval_cmp (time_end, time_now, &time_left) <= 0)
 447                         timeout = 0;
 448                 else
 449                         timeout = 1000 * time_left.tv_sec
 450                                 + ((time_left.tv_usec + 500) / 1000);
 451
 452                 /* timeout reached */
 453                 if (timeout <= 0)
 454                         break;
 455
 456                 poll_s.fd      = sd;
 457                 poll_s.events  = POLLIN | POLLPRI;
 458                 poll_s.revents = 0;
 459
 460                 DEBUG ("Polling for %ims", timeout);
 461                 status = poll (&poll_s, 1, timeout);
 462
 463                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
 464                         continue;
 465
 466                 if (status < 0)
 467                 {
 468                         char errbuf[1024];
 469                         ERROR ("ntpd plugin: poll failed: %s",
 470                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 471                         return (-1);
 472                 }
 473
 474                 if (status == 0) /* timeout */
 475                 {
 476                         DEBUG ("timeout reached.");
 477                         break;
 478                 }
 479
 480                 memset ((void *) &res, '\0', sizeof (res));
 481                 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
 482
 483                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
 484                         continue;
 485
 486                 if (status < 0)
 487                 {
 488                         char errbuf[1024];
 489                         INFO ("recv(2) failed: %s",
 490                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 491                         DEBUG ("Closing socket #%i", sd);
 492                         close (sd);
 493                         sock_descr = sd = -1;
 494                         return (-1);
 495                 }
 496
 497                 DEBUG ("recv'd %i bytes", status);
 498
 499                 /*
 500                  * Do some sanity checks first
 501                  */
 502                 if (status < RESP_HEADER_SIZE)
 503                 {
 504                         WARNING ("ntpd plugin: Short (%i bytes) packet received",
 505                                         (int) status);
 506                         continue;
 507                 }
 508                 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
 509                 {
 510                         NOTICE ("ntpd plugin: Packet received with mode %i",
 511                                         INFO_MODE (res.rm_vn_mode));
 512                         continue;
 513                 }
 514                 if (INFO_IS_AUTH (res.auth_seq))
 515                 {
 516                         NOTICE ("ntpd plugin: Encrypted packet received");
 517                         continue;
 518                 }
 519                 if (!ISRESPONSE (res.rm_vn_mode))
 520                 {
 521                         NOTICE ("ntpd plugin: Received request packet, "
 522                                         "wanted response");
 523                         continue;
 524                 }
 525                 if (INFO_MBZ (res.mbz_itemsize))
 526                 {
 527                         WARNING ("ntpd plugin: Received packet with nonzero "
 528                                         "MBZ field!");
 529                         continue;
 530                 }
 531                 if (res.implementation != IMPL_XNTPD)
 532                 {
 533                         WARNING ("ntpd plugin: Asked for request of type %i, "
 534                                         "got %i", (int) IMPL_XNTPD, (int) res.implementation);
 535                         continue;
 536                 }
 537
 538                 /* Check for error code */
 539                 if (INFO_ERR (res.err_nitems) != 0)
 540                 {
 541                         ERROR ("ntpd plugin: Received error code %i",
 542                                         (int) INFO_ERR(res.err_nitems));
 543                         return ((int) INFO_ERR (res.err_nitems));
 544                 }
 545
 546                 /* extract number of items in this packet and the size of these items */
 547                 pkt_item_num = INFO_NITEMS (res.err_nitems);
 548                 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
 549                 DEBUG ("pkt_item_num = %i; pkt_item_len = %i;",
 550                                 pkt_item_num, pkt_item_len);
 551
 552                 /* Check if the reported items fit in the packet */
 553                 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
 554                 {
 555                         ERROR ("ntpd plugin: %i items * %i bytes > "
 556                                         "%i bytes - %i bytes header",
 557                                         (int) pkt_item_num, (int) pkt_item_len,
 558                                         (int) status, (int) RESP_HEADER_SIZE);
 559                         continue;
 560                 }
 561
 562                 if (pkt_item_len > res_item_size)
 563                 {
 564                         ERROR ("ntpd plugin: (pkt_item_len = %i) "
 565                                         ">= (res_item_size = %i)",
 566                                         pkt_item_len, res_item_size);
 567                         continue;
 568                 }
 569
 570                 /* If this is the first packet (time wise, not sequence wise),
 571                  * set `res_size'. If it's not the first packet check if the
 572                  * items have the same size. Discard invalid packets. */
 573                 if (items_num == 0) /* first packet */
 574                 {
 575                         DEBUG ("*res_size = %i", pkt_item_len);
 576                         *res_size = pkt_item_len;
 577                 }
 578                 else if (*res_size != pkt_item_len)
 579                 {
 580                         DEBUG ("Error: *res_size = %i; pkt_item_len = %i;",
 581                                         *res_size, pkt_item_len);
 582                         ERROR ("Item sizes differ.");
 583                         continue;
 584                 }
 585
 586                 /*
 587                  * Because the items in the packet may be smaller than the
 588                  * items requested, the following holds true:
 589                  */
 590                 assert ((*res_size == pkt_item_len)
 591                                 && (pkt_item_len <= res_item_size));
 592
 593                 /* Calculate the padding. No idea why there might be any padding.. */
 594                 pkt_padding = 0;
 595                 if (pkt_item_len < res_item_size)
 596                         pkt_padding = res_item_size - pkt_item_len;
 597                 DEBUG ("res_item_size = %i; pkt_padding = %zi;",
 598                                 res_item_size, pkt_padding);
 599
 600                 /* Extract the sequence number */
 601                 pkt_sequence = INFO_SEQ (res.auth_seq);
 602                 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
 603                 {
 604                         ERROR ("ntpd plugin: Received packet with sequence %i",
 605                                         pkt_sequence);
 606                         continue;
 607                 }
 608
 609                 /* Check if this sequence has been received before. If so, discard it. */
 610                 if (pkt_recvd[pkt_sequence] != '\0')
 611                 {
 612                         NOTICE ("ntpd plugin: Sequence %i received twice",
 613                                         pkt_sequence);
 614                         continue;
 615                 }
 616
 617                 /* If `pkt_lastseq != -1' another packet without `more bit' has
 618                  * been received. */
 619                 if (!ISMORE (res.rm_vn_mode))
 620                 {
 621                         if (pkt_lastseq != -1)
 622                         {
 623                                 ERROR ("ntpd plugin: Two packets which both "
 624                                                 "claim to be the last one in the "
 625                                                 "sequence have been received.");
 626                                 continue;
 627                         }
 628                         pkt_lastseq = pkt_sequence;
 629                         DEBUG ("Last sequence = %i;", pkt_lastseq);
 630                 }
 631
 632                 /*
 633                  * Enough with the checks. Copy the data now.
 634                  * We start by allocating some more memory.
 635                  */
 636                 DEBUG ("realloc (%p, %zu)", (void *) *res_data,
 637                                 (items_num + pkt_item_num) * res_item_size);
 638                 items = realloc ((void *) *res_data,
 639                                 (items_num + pkt_item_num) * res_item_size);
 640                 if (items == NULL)
 641                 {
 642                         items = *res_data;
 643                         ERROR ("ntpd plugin: realloc failed.");
 644                         continue;
 645                 }
 646                 items_num += pkt_item_num;
 647                 *res_data = items;
 648
 649                 for (i = 0; i < pkt_item_num; i++)
 650                 {
 651                         /* dst: There are already `*res_items' items with
 652                          *      res_item_size bytes each in in `*res_data'. Set
 653                          *      dst to the first byte after that. */
 654                         void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
 655                         /* src: We use `pkt_item_len' to calculate the offset
 656                          *      from the beginning of the packet, because the
 657                          *      items in the packet may be smaller than the
 658                          *      items that were requested. We skip `i' such
 659                          *      items. */
 660                         void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
 661
 662                         /* Set the padding to zeros */
 663                         if (pkt_padding != 0)
 664                                 memset (dst, '\0', res_item_size);
 665                         memcpy (dst, src, (size_t) pkt_item_len);
 666
 667                         /* Increment `*res_items' by one, so `dst' will end up
 668                          * one further in the next round. */
 669                         (*res_items)++;
 670                 } /* for (pkt_item_num) */
 671
 672                 pkt_recvd[pkt_sequence] = (char) 1;
 673                 pkt_recvd_num++;
 674
 675                 if ((pkt_recvd_num - 1) == pkt_lastseq)
 676                         done = 1;
 677         } /* while (done == 0) */
 678
 679         return (0);
 680 } /* int ntpd_receive_response */
 681
 682 /* For a description of the arguments see `ntpd_do_query' below. */
 683 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
 684 {
 685         int             sd;
 686         struct req_pkt  req;
 687         size_t          req_data_len;
 688         int             status;
 689
 690         assert (req_items >= 0);
 691         assert (req_size  >= 0);
 692
 693         if ((sd = ntpd_connect ()) < 0)
 694                 return (-1);
 695
 696         memset ((void *) &req, '\0', sizeof (req));
 697         req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
 698         req.auth_seq   = AUTH_SEQ (0, 0);
 699         req.implementation = IMPL_XNTPD;
 700         req.request = (unsigned char) req_code;
 701
 702         req_data_len = (size_t) (req_items * req_size);
 703
 704         assert (((req_data != NULL) && (req_data_len > 0))
 705                         || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
 706
 707         req.err_nitems   = ERR_NITEMS (0, req_items);
 708         req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
 709
 710         if (req_data != NULL)
 711                 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
 712
 713         DEBUG ("req_items = %i; req_size = %i; req_data = %p;",
 714                         req_items, req_size, (void *) req_data);
 715
 716         status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
 717         if (status < 0)
 718         {
 719                 DEBUG ("`swrite' failed. Closing socket #%i", sd);
 720                 close (sd);
 721                 sock_descr = sd = -1;
 722                 return (status);
 723         }
 724
 725         return (0);
 726 }
 727
 728 /*
 729  * ntpd_do_query:
 730  *
 731  * req_code:      Type of request packet
 732  * req_items:     Numver of items in the request
 733  * req_size:      Size of one item in the request
 734  * req_data:      Data of the request packet
 735  * res_items:     Pointer to where the number returned items will be stored.
 736  * res_size:      Pointer to where the size of one returned item will be stored.
 737  * res_data:      This is where a pointer to the (allocated) data will be stored.
 738  * res_item_size: Size of one returned item. (used to calculate padding)
 739  *
 740  * returns:       zero upon success, non-zero otherwise.
 741  */
 742 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
 743                 int *res_items, int *res_size, char **res_data, int res_item_size)
 744 {
 745         int status;
 746
 747         status = ntpd_send_request (req_code, req_items, req_size, req_data);
 748         if (status != 0)
 749                 return (status);
 750
 751         status = ntpd_receive_response (res_items, res_size, res_data,
 752                         res_item_size);
 753         return (status);
 754 }
 755
 756 static double ntpd_read_fp (int32_t val_int)
 757 {
 758         double val_double;
 759
 760         val_int = ntohl (val_int);
 761         val_double = ((double) val_int) / FP_FRAC;
 762
 763         return (val_double);
 764 }
 765
 766 static int ntpd_read (void)
 767 {
 768         struct info_kernel *ik;
 769         int                 ik_num;
 770         int                 ik_size;
 771
 772         struct info_peer_summary *ps;
 773         int                       ps_num;
 774         int                       ps_size;
 775
 776         int status;
 777         int i;
 778
 779         ik      = NULL;
 780         ik_num  = 0;
 781         ik_size = 0;
 782
 783         status = ntpd_do_query (REQ_GET_KERNEL,
 784                         0, 0, NULL, /* request data */
 785                         &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
 786                         sizeof (struct info_kernel));
 787
 788         if (status != 0)
 789         {
 790                 DEBUG ("ntpd_do_query failed with status %i", status);
 791                 return (-1);
 792         }
 793         if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
 794         {
 795                 DEBUG ("ntpd_do_query returned: ik = %p; ik_num = %i; ik_size = %i;",
 796                                 (void *) ik, ik_num, ik_size);
 797                 return (-1);
 798         }
 799
 800         /* kerninfo -> estimated error */
 801
 802         DEBUG ("info_kernel:\n"
 803                         "  pll offset    = %.8f\n"
 804                         "  pll frequency = %.8f\n" /* drift compensation */
 805                         "  est error     = %.8f\n",
 806                         ntpd_read_fp (ik->offset),
 807                         ntpd_read_fp (ik->freq),
 808                         ntpd_read_fp (ik->esterror));
 809
 810         ntpd_submit ("frequency_offset", "loop",  ntpd_read_fp (ik->freq));
 811         ntpd_submit ("time_offset",      "loop",  ntpd_read_fp (ik->offset));
 812         ntpd_submit ("time_offset",      "error", ntpd_read_fp (ik->esterror));
 813
 814         free (ik);
 815         ik = NULL;
 816
 817         status = ntpd_do_query (REQ_PEER_LIST_SUM,
 818                         0, 0, NULL, /* request data */
 819                         &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
 820                         sizeof (struct info_peer_summary));
 821         if (status != 0)
 822         {
 823                 DEBUG ("ntpd_do_query failed with status %i", status);
 824                 return (-1);
 825         }
 826         if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
 827         {
 828                 DEBUG ("ntpd_do_query returned: ps = %p; ps_num = %i; ps_size = %i;",
 829                                 (void *) ps, ps_num, ps_size);
 830                 return (-1);
 831         }
 832
 833         for (i = 0; i < ps_num; i++)
 834         {
 835                 struct info_peer_summary *ptr;
 836                 double offset;
 837
 838                 char peername[NI_MAXHOST];
 839                 int refclock_id;
 840
 841                 ptr = ps + i;
 842                 refclock_id = 0;
 843
 844                 /* Convert the `long floating point' offset value to double */
 845                 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
 846
 847                 /* Special IP addresses for hardware clocks and stuff.. */
 848                 if (!ptr->v6_flag
 849                                 && ((ntohl (ptr->srcadr) & REFCLOCK_MASK)
 850                                         == REFCLOCK_ADDR))
 851                 {
 852                         struct in_addr  addr_obj;
 853                         char *addr_str;
 854
 855                         refclock_id = (ntohl (ptr->srcadr) >> 8) & 0x000000FF;
 856
 857                         if (refclock_id < refclock_names_num)
 858                         {
 859                                 sstrncpy (peername, refclock_names[refclock_id],
 860                                                 sizeof (peername));
 861                         }
 862                         else
 863                         {
 864                                 memset ((void *) &addr_obj, '\0', sizeof (addr_obj));
 865                                 addr_obj.s_addr = ptr->srcadr;
 866                                 addr_str = inet_ntoa (addr_obj);
 867
 868                                 sstrncpy (peername, addr_str, sizeof (peername));
 869                         }
 870                 }
 871                 else /* Normal network host. */
 872                 {
 873                         struct sockaddr_storage sa;
 874                         socklen_t sa_len;
 875                         int flags = 0;
 876
 877                         memset (&sa, '\0', sizeof (sa));
 878
 879                         if (ptr->v6_flag)
 880                         {
 881                                 struct sockaddr_in6 sa6;
 882
 883                                 assert (sizeof (sa) >= sizeof (sa6));
 884
 885                                 memset (&sa6, 0, sizeof (sa6));
 886                                 sa6.sin6_family = AF_INET6;
 887                                 sa6.sin6_port = htons (123);
 888                                 memcpy (&sa6.sin6_addr, &ptr->srcadr6,
 889                                                 sizeof (struct in6_addr));
 890                                 sa_len = sizeof (sa6);
 891
 892                                 memcpy (&sa, &sa6, sizeof (sa6));
 893                         }
 894                         else
 895                         {
 896                                 struct sockaddr_in sa4;
 897
 898                                 assert (sizeof (sa) >= sizeof (sa4));
 899
 900                                 memset (&sa4, 0, sizeof (sa4));
 901                                 sa4.sin_family = AF_INET;
 902                                 sa4.sin_port = htons (123);
 903                                 memcpy (&sa4.sin_addr, &ptr->srcadr,
 904                                                 sizeof (struct in_addr));
 905                                 sa_len = sizeof (sa4);
 906
 907                                 memcpy (&sa, &sa4, sizeof (sa4));
 908                         }
 909
 910                         if (do_reverse_lookups == 0)
 911                                 flags |= NI_NUMERICHOST;
 912
 913                         status = getnameinfo ((const struct sockaddr *) &sa,
 914                                         sa_len,
 915                                         peername, sizeof (peername),
 916                                         NULL, 0, /* No port name */
 917                                         flags);
 918                         if (status != 0)
 919                         {
 920                                 char errbuf[1024];
 921                                 ERROR ("ntpd plugin: getnameinfo failed: %s",
 922                                                 (status == EAI_SYSTEM)
 923                                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 924                                                 : gai_strerror (status));
 925                                 continue;
 926                         }
 927                 }
 928
 929                 DEBUG ("peer %i:\n"
 930                                 "  peername   = %s\n"
 931                                 "  srcadr     = 0x%08x\n"
 932                                 "  delay      = %f\n"
 933                                 "  offset_int = %i\n"
 934                                 "  offset_frc = %i\n"
 935                                 "  offset     = %f\n"
 936                                 "  dispersion = %f\n",
 937                                 i,
 938                                 peername,
 939                                 ntohl (ptr->srcadr),
 940                                 ntpd_read_fp (ptr->delay),
 941                                 ntohl (ptr->offset_int),
 942                                 ntohl (ptr->offset_frc),
 943                                 offset,
 944                                 ntpd_read_fp (ptr->dispersion));
 945
 946                 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
 947                         ntpd_submit ("time_offset", peername, offset);
 948                 ntpd_submit ("time_dispersion", peername, ntpd_read_fp (ptr->dispersion));
 949                 if (refclock_id == 0) /* not a reference clock */
 950                         ntpd_submit ("delay", peername, ntpd_read_fp (ptr->delay));
 951         }
 952
 953         free (ps);
 954         ps = NULL;
 955
 956         return (0);
 957 } /* int ntpd_read */
 958
 959 void module_register (void)
 960 {
 961         plugin_register_config ("ntpd", ntpd_config,
 962                         config_keys, config_keys_num);
 963         plugin_register_read ("ntpd", ntpd_read);
 964 } /* void module_register */