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