src/ntpd.c

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