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