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