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