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 _BSD_SOURCE /* For NI_MAXHOST */
  28
  29 #include "collectd.h"
  30 #include "common.h"
  31 #include "plugin.h"
  32 #include "configfile.h"
  33
  34 #if HAVE_STDINT_H
  35 # include <stdint.h>
  36 #endif
  37 #if HAVE_NETDB_H
  38 # include <netdb.h>
  39 #endif
  40 #if HAVE_SYS_SOCKET_H
  41 # include <sys/socket.h>
  42 #endif
  43 #if HAVE_NETINET_IN_H
  44 # include <netinet/in.h>
  45 #endif
  46 #if HAVE_ARPA_INET_H
  47 # include <arpa/inet.h> /* inet_ntoa */
  48 #endif
  49 #if HAVE_NETINET_TCP_H
  50 # include <netinet/tcp.h>
  51 #endif
  52 #if HAVE_POLL_H
  53 # include <poll.h>
  54 #endif
  55
  56 static const char *config_keys[] =
  57 {
  58         "Host",
  59         "Port",
  60         "ReverseLookups",
  61         "IncludeUnitID"
  62 };
  63 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  64
  65 static _Bool do_reverse_lookups = 1;
  66
  67 /* This option only exists for backward compatibility. If it is false and two
  68  * ntpd peers use the same refclock driver, the plugin will try to write
  69  * simultaneous measurements from both to the same type instance. */
  70 static _Bool include_unit_id = 0;
  71
  72 # define NTPD_DEFAULT_HOST "localhost"
  73 # define NTPD_DEFAULT_PORT "123"
  74 static int   sock_descr = -1;
  75 static char *ntpd_host = NULL;
  76 static char  ntpd_port[16];
  77
  78 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  79  * The following definitions were copied from the NTPd distribution  *
  80  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  81 #define MAXFILENAME 128
  82 #define MAXSEQ  127
  83 #define MODE_PRIVATE 7
  84 #define NTP_OLDVERSION ((uint8_t) 1) /* oldest credible version */
  85 #define IMPL_XNTPD 3
  86 #define FP_FRAC 65536.0
  87
  88 #define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */
  89 #define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */
  90
  91 /* This structure is missing the message authentication code, since collectd
  92  * doesn't use it. */
  93 struct req_pkt
  94 {
  95         uint8_t  rm_vn_mode;
  96         uint8_t  auth_seq;
  97         uint8_t  implementation;                /* implementation number */
  98         uint8_t  request;                       /* request number */
  99         uint16_t err_nitems;            /* error code/number of data items */
 100         uint16_t mbz_itemsize;          /* item size */
 101         char     data[MAXFILENAME + 48];        /* data area [32 prev](176 byte max) */
 102                                         /* struct conf_peer must fit */
 103 };
 104 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
 105
 106 /*
 107  * A response packet.  The length here is variable, this is a
 108  * maximally sized one.  Note that this implementation doesn't
 109  * authenticate responses.
 110  */
 111 #define RESP_HEADER_SIZE        (8)
 112 #define RESP_DATA_SIZE          (500)
 113
 114 struct resp_pkt
 115 {
 116         uint8_t  rm_vn_mode;           /* response, more, version, mode */
 117         uint8_t  auth_seq;             /* key, sequence number */
 118         uint8_t  implementation;       /* implementation number */
 119         uint8_t  request;              /* request number */
 120         uint16_t err_nitems;           /* error code/number of data items */
 121         uint16_t mbz_itemsize;         /* item size */
 122         char     data[RESP_DATA_SIZE]; /* data area */
 123 };
 124
 125 /*
 126  * Bit setting macros for multifield items.
 127  */
 128 #define RESP_BIT        0x80
 129 #define MORE_BIT        0x40
 130
 131 #define ISRESPONSE(rm_vn_mode)  (((rm_vn_mode)&RESP_BIT)!=0)
 132 #define ISMORE(rm_vn_mode)      (((rm_vn_mode)&MORE_BIT)!=0)
 133 #define INFO_VERSION(rm_vn_mode) ((uint8_t)(((rm_vn_mode)>>3)&0x7))
 134 #define INFO_MODE(rm_vn_mode)   ((rm_vn_mode)&0x7)
 135
 136 #define RM_VN_MODE(resp, more, version)         \
 137                                 ((uint8_t)(((resp)?RESP_BIT:0)\
 138                                 |((more)?MORE_BIT:0)\
 139                                 |((version?version:(NTP_OLDVERSION+1))<<3)\
 140                                 |(MODE_PRIVATE)))
 141
 142 #define INFO_IS_AUTH(auth_seq)  (((auth_seq) & 0x80) != 0)
 143 #define INFO_SEQ(auth_seq)      ((auth_seq)&0x7f)
 144 #define AUTH_SEQ(auth, seq)     ((uint8_t)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
 145
 146 #define INFO_ERR(err_nitems)    ((uint16_t)((ntohs(err_nitems)>>12)&0xf))
 147 #define INFO_NITEMS(err_nitems) ((uint16_t)(ntohs(err_nitems)&0xfff))
 148 #define ERR_NITEMS(err, nitems) (htons((uint16_t)((((uint16_t)(err)<<12)&0xf000)\
 149                                 |((uint16_t)(nitems)&0xfff))))
 150
 151 #define INFO_MBZ(mbz_itemsize)  ((ntohs(mbz_itemsize)>>12)&0xf)
 152 #define INFO_ITEMSIZE(mbz_itemsize)     ((uint16_t)(ntohs(mbz_itemsize)&0xfff))
 153 #define MBZ_ITEMSIZE(itemsize)  (htons((uint16_t)(itemsize)))
 154
 155 /* negate a long float type */
 156 #define M_NEG(v_i, v_f) \
 157         do { \
 158                 if ((v_f) == 0) \
 159                 (v_i) = -((uint32_t)(v_i)); \
 160                 else { \
 161                         (v_f) = -((uint32_t)(v_f)); \
 162                         (v_i) = ~(v_i); \
 163                 } \
 164         } while(0)
 165 /* l_fp to double */
 166 #define M_LFPTOD(r_i, r_uf, d) \
 167         do { \
 168                 register int32_t  i; \
 169                 register uint32_t f; \
 170                 \
 171                 i = (r_i); \
 172                 f = (r_uf); \
 173                 if (i < 0) { \
 174                         M_NEG(i, f); \
 175                         (d) = -((double) i + ((double) f) / 4294967296.0); \
 176                 } else { \
 177                         (d) = (double) i + ((double) f) / 4294967296.0; \
 178                 } \
 179         } while (0)
 180
 181 #define REQ_PEER_LIST_SUM 1
 182 struct info_peer_summary
 183 {
 184         uint32_t dstadr;         /* local address (zero for undetermined) */
 185         uint32_t srcadr;         /* source address */
 186         uint16_t srcport;        /* source port */
 187         uint8_t stratum;         /* stratum of peer */
 188         int8_t hpoll;            /* host polling interval */
 189         int8_t ppoll;            /* peer polling interval */
 190         uint8_t reach;           /* reachability register */
 191         uint8_t flags;           /* flags, from above */
 192         uint8_t hmode;           /* peer mode */
 193         int32_t  delay;          /* peer.estdelay; s_fp */
 194         int32_t  offset_int;     /* peer.estoffset; integral part */
 195         int32_t  offset_frc;     /* peer.estoffset; fractional part */
 196         uint32_t dispersion;     /* peer.estdisp; u_fp */
 197         uint32_t v6_flag;        /* is this v6 or not */
 198         uint32_t unused1;        /* (unused) padding for dstadr6 */
 199         struct in6_addr dstadr6; /* local address (v6) */
 200         struct in6_addr srcadr6; /* source address (v6) */
 201 };
 202
 203 #define REQ_SYS_INFO 4
 204 struct info_sys
 205 {
 206         uint32_t peer;           /* system peer address (v4) */
 207         uint8_t  peer_mode;      /* mode we are syncing to peer in */
 208         uint8_t  leap;           /* system leap bits */
 209         uint8_t  stratum;        /* our stratum */
 210         int8_t   precision;      /* local clock precision */
 211         int32_t  rootdelay;      /* distance from sync source */
 212         uint32_t rootdispersion; /* dispersion from sync source */
 213         uint32_t refid;          /* reference ID of sync source */
 214         uint64_t reftime;        /* system reference time */
 215         uint32_t poll;           /* system poll interval */
 216         uint8_t  flags;          /* system flags */
 217         uint8_t  unused1;        /* unused */
 218         uint8_t  unused2;        /* unused */
 219         uint8_t  unused3;        /* unused */
 220         int32_t  bdelay;         /* default broadcast offset */
 221         int32_t  frequency;      /* frequency residual (scaled ppm)  */
 222         uint64_t authdelay;      /* default authentication delay */
 223         uint32_t stability;      /* clock stability (scaled ppm) */
 224         int32_t  v6_flag;        /* is this v6 or not */
 225         int32_t  unused4;        /* unused, padding for peer6 */
 226         struct in6_addr peer6;   /* system peer address (v6) */
 227 };
 228
 229 #define REQ_GET_KERNEL 38
 230 struct info_kernel
 231 {
 232         int32_t  offset;
 233         int32_t  freq;
 234         int32_t  maxerror;
 235         int32_t  esterror;
 236         uint16_t status;
 237         uint16_t shift;
 238         int32_t  constant;
 239         int32_t  precision;
 240         int32_t  tolerance;
 241         /* pps stuff */
 242         int32_t  ppsfreq;
 243         int32_t  jitter;
 244         int32_t  stabil;
 245         int32_t  jitcnt;
 246         int32_t  calcnt;
 247         int32_t  errcnt;
 248         int32_t  stbcnt;
 249 };
 250
 251 /* List of reference clock names */
 252 static char *refclock_names[] =
 253 {
 254         "UNKNOWN",    "LOCAL",        "GPS_TRAK",   "WWV_PST",     /*  0- 3 */
 255         "SPECTRACOM", "TRUETIME",     "IRIG_AUDIO", "CHU_AUDIO",   /*  4- 7 */
 256         "GENERIC",    "GPS_MX4200",   "GPS_AS2201", "GPS_ARBITER", /*  8-11 */
 257         "IRIG_TPRO",  "ATOM_LEITCH",  "MSF_EES",    "GPSTM_TRUE",  /* 12-15 */
 258         "GPS_BANC",   "GPS_DATUM",    "ACTS_NIST",  "WWV_HEATH",   /* 16-19 */
 259         "GPS_NMEA",   "GPS_VME",      "PPS",        "ACTS_PTB",    /* 20-23 */
 260         "ACTS_USNO",  "TRUETIME",     "GPS_HP",     "MSF_ARCRON",  /* 24-27 */
 261         "SHM",        "GPS_PALISADE", "GPS_ONCORE", "GPS_JUPITER", /* 28-31 */
 262         "CHRONOLOG",  "DUMBCLOCK",    "ULINK_M320", "PCF",         /* 32-35 */
 263         "WWV_AUDIO",  "GPS_FG",       "HOPF_S",     "HOPF_P",      /* 36-39 */
 264         "JJY",        "TT_IRIG",      "GPS_ZYFER",  "GPS_RIPENCC", /* 40-43 */
 265         "NEOCLK4X"                                                 /* 44    */
 266 };
 267 static int refclock_names_num = STATIC_ARRAY_SIZE (refclock_names);
 268 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 269  * End of the copied stuff..                                         *
 270  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 271
 272 static int ntpd_config (const char *key, const char *value)
 273 {
 274         if (strcasecmp (key, "Host") == 0)
 275         {
 276                 if (ntpd_host != NULL)
 277                         free (ntpd_host);
 278                 if ((ntpd_host = strdup (value)) == NULL)
 279                         return (1);
 280         }
 281         else if (strcasecmp (key, "Port") == 0)
 282         {
 283                 int port = (int) (atof (value));
 284                 if ((port > 0) && (port <= 65535))
 285                         ssnprintf (ntpd_port, sizeof (ntpd_port),
 286                                         "%i", port);
 287                 else
 288                         sstrncpy (ntpd_port, value, sizeof (ntpd_port));
 289         }
 290         else if (strcasecmp (key, "ReverseLookups") == 0)
 291         {
 292                 if (IS_TRUE (value))
 293                         do_reverse_lookups = 1;
 294                 else
 295                         do_reverse_lookups = 0;
 296         }
 297         else if (strcasecmp (key, "IncludeUnitID") == 0)
 298         {
 299                 if (IS_TRUE (value))
 300                         include_unit_id = 1;
 301                 else
 302                         include_unit_id = 0;
 303         }
 304         else
 305         {
 306                 return (-1);
 307         }
 308
 309         return (0);
 310 }
 311
 312 static void ntpd_submit (char *type, char *type_inst, double value)
 313 {
 314         value_t values[1];
 315         value_list_t vl = VALUE_LIST_INIT;
 316
 317         values[0].gauge = value;
 318
 319         vl.values = values;
 320         vl.values_len = 1;
 321         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 322         sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
 323         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
 324         sstrncpy (vl.type, type, sizeof (vl.type));
 325         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 326
 327         plugin_dispatch_values (&vl);
 328 }
 329
 330 /* Each time a peer is polled, ntpd shifts the reach register to the left and
 331  * sets the LSB based on whether the peer was reachable. If the LSB is zero,
 332  * the values are out of date. */
 333 static void ntpd_submit_reach (char *type, char *type_inst, uint8_t reach,
 334                 double value)
 335 {
 336         if (!(reach & 1))
 337                 value = NAN;
 338
 339         ntpd_submit (type, type_inst, value);
 340 }
 341
 342 static int ntpd_connect (void)
 343 {
 344         char *host;
 345         char *port;
 346
 347         struct addrinfo  ai_hints;
 348         struct addrinfo *ai_list;
 349         struct addrinfo *ai_ptr;
 350         int              status;
 351
 352         if (sock_descr >= 0)
 353                 return (sock_descr);
 354
 355         DEBUG ("Opening a new socket");
 356
 357         host = ntpd_host;
 358         if (host == NULL)
 359                 host = NTPD_DEFAULT_HOST;
 360
 361         port = ntpd_port;
 362         if (strlen (port) == 0)
 363                 port = NTPD_DEFAULT_PORT;
 364
 365         memset (&ai_hints, '\0', sizeof (ai_hints));
 366         ai_hints.ai_flags    = 0;
 367 #ifdef AI_ADDRCONFIG
 368         ai_hints.ai_flags   |= AI_ADDRCONFIG;
 369 #endif
 370         ai_hints.ai_family   = PF_UNSPEC;
 371         ai_hints.ai_socktype = SOCK_DGRAM;
 372         ai_hints.ai_protocol = IPPROTO_UDP;
 373
 374         if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
 375         {
 376                 char errbuf[1024];
 377                 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
 378                                 host, port,
 379                                 (status == EAI_SYSTEM)
 380                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 381                                 : gai_strerror (status));
 382                 return (-1);
 383         }
 384
 385         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 386         {
 387                 /* create our socket descriptor */
 388                 if ((sock_descr = socket (ai_ptr->ai_family,
 389                                                 ai_ptr->ai_socktype,
 390                                                 ai_ptr->ai_protocol)) < 0)
 391                         continue;
 392
 393                 /* connect to the ntpd */
 394                 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
 395                 {
 396                         close (sock_descr);
 397                         sock_descr = -1;
 398                         continue;
 399                 }
 400
 401                 break;
 402         }
 403
 404         freeaddrinfo (ai_list);
 405
 406         if (sock_descr < 0)
 407         {
 408                 ERROR ("ntpd plugin: Unable to connect to server.");
 409         }
 410
 411         return (sock_descr);
 412 }
 413
 414 /* For a description of the arguments see `ntpd_do_query' below. */
 415 static int ntpd_receive_response (int *res_items, int *res_size,
 416                 char **res_data, int res_item_size)
 417 {
 418         int              sd;
 419         struct pollfd    poll_s;
 420         struct resp_pkt  res;
 421         int              status;
 422         int              done;
 423         int              i;
 424
 425         char            *items;
 426         size_t           items_num;
 427
 428         struct timeval   time_end;
 429         struct timeval   time_now;
 430         int              timeout;
 431
 432         int              pkt_item_num;        /* items in this packet */
 433         int              pkt_item_len;        /* size of the items in this packet */
 434         int              pkt_sequence;
 435         char             pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
 436         int              pkt_recvd_num;       /* number of packets that have been received */
 437         int              pkt_lastseq;         /* the last sequence number */
 438         ssize_t          pkt_padding;         /* Padding in this packet */
 439
 440         if ((sd = ntpd_connect ()) < 0)
 441                 return (-1);
 442
 443         items = NULL;
 444         items_num = 0;
 445
 446         memset (pkt_recvd, '\0', sizeof (pkt_recvd));
 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 ((void *) &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 ((void *) *res_data,
 669                                 (items_num + pkt_item_num) * res_item_size);
 670                 if (items == NULL)
 671                 {
 672                         items = *res_data;
 673                         ERROR ("ntpd plugin: realloc failed.");
 674                         continue;
 675                 }
 676                 items_num += pkt_item_num;
 677                 *res_data = items;
 678
 679                 for (i = 0; i < pkt_item_num; i++)
 680                 {
 681                         /* dst: There are already `*res_items' items with
 682                          *      res_item_size bytes each in in `*res_data'. Set
 683                          *      dst to the first byte after that. */
 684                         void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
 685                         /* src: We use `pkt_item_len' to calculate the offset
 686                          *      from the beginning of the packet, because the
 687                          *      items in the packet may be smaller than the
 688                          *      items that were requested. We skip `i' such
 689                          *      items. */
 690                         void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
 691
 692                         /* Set the padding to zeros */
 693                         if (pkt_padding != 0)
 694                                 memset (dst, '\0', res_item_size);
 695                         memcpy (dst, src, (size_t) pkt_item_len);
 696
 697                         /* Increment `*res_items' by one, so `dst' will end up
 698                          * one further in the next round. */
 699                         (*res_items)++;
 700                 } /* for (pkt_item_num) */
 701
 702                 pkt_recvd[pkt_sequence] = (char) 1;
 703                 pkt_recvd_num++;
 704
 705                 if ((pkt_recvd_num - 1) == pkt_lastseq)
 706                         done = 1;
 707         } /* while (done == 0) */
 708
 709         return (0);
 710 } /* int ntpd_receive_response */
 711
 712 /* For a description of the arguments see `ntpd_do_query' below. */
 713 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
 714 {
 715         int             sd;
 716         struct req_pkt  req;
 717         size_t          req_data_len;
 718         int             status;
 719
 720         assert (req_items >= 0);
 721         assert (req_size  >= 0);
 722
 723         if ((sd = ntpd_connect ()) < 0)
 724                 return (-1);
 725
 726         memset ((void *) &req, '\0', sizeof (req));
 727         req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
 728         req.auth_seq   = AUTH_SEQ (0, 0);
 729         req.implementation = IMPL_XNTPD;
 730         req.request = (unsigned char) req_code;
 731
 732         req_data_len = (size_t) (req_items * req_size);
 733
 734         assert (((req_data != NULL) && (req_data_len > 0))
 735                         || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
 736
 737         req.err_nitems   = ERR_NITEMS (0, req_items);
 738         req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
 739
 740         if (req_data != NULL)
 741                 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
 742
 743         DEBUG ("req_items = %i; req_size = %i; req_data = %p;",
 744                         req_items, req_size, (void *) req_data);
 745
 746         status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
 747         if (status < 0)
 748         {
 749                 DEBUG ("`swrite' failed. Closing socket #%i", sd);
 750                 close (sd);
 751                 sock_descr = sd = -1;
 752                 return (status);
 753         }
 754
 755         return (0);
 756 }
 757
 758 /*
 759  * ntpd_do_query:
 760  *
 761  * req_code:      Type of request packet
 762  * req_items:     Numver of items in the request
 763  * req_size:      Size of one item in the request
 764  * req_data:      Data of the request packet
 765  * res_items:     Pointer to where the number returned items will be stored.
 766  * res_size:      Pointer to where the size of one returned item will be stored.
 767  * res_data:      This is where a pointer to the (allocated) data will be stored.
 768  * res_item_size: Size of one returned item. (used to calculate padding)
 769  *
 770  * returns:       zero upon success, non-zero otherwise.
 771  */
 772 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
 773                 int *res_items, int *res_size, char **res_data, int res_item_size)
 774 {
 775         int status;
 776
 777         status = ntpd_send_request (req_code, req_items, req_size, req_data);
 778         if (status != 0)
 779                 return (status);
 780
 781         status = ntpd_receive_response (res_items, res_size, res_data,
 782                         res_item_size);
 783         return (status);
 784 }
 785
 786 static double ntpd_read_fp (int32_t val_int)
 787 {
 788         double val_double;
 789
 790         val_int = ntohl (val_int);
 791         val_double = ((double) val_int) / FP_FRAC;
 792
 793         return (val_double);
 794 }
 795
 796 static uint32_t ntpd_get_refclock_id (struct info_peer_summary const *peer_info)
 797 {
 798         uint32_t addr = ntohl (peer_info->srcadr);
 799         uint32_t refclock_id = (addr >> 8) & 0x00FF;
 800
 801         return (refclock_id);
 802 }
 803
 804 static int ntpd_get_name_from_address (char *buffer, size_t buffer_size,
 805                 struct info_peer_summary const *peer_info, _Bool do_reverse_lookup)
 806 {
 807         struct sockaddr_storage sa;
 808         socklen_t sa_len;
 809         int flags = 0;
 810         int status;
 811
 812         memset (&sa, 0, sizeof (sa));
 813
 814         if (peer_info->v6_flag)
 815         {
 816                 struct sockaddr_in6 sa6;
 817
 818                 assert (sizeof (sa) >= sizeof (sa6));
 819
 820                 memset (&sa6, 0, sizeof (sa6));
 821                 sa6.sin6_family = AF_INET6;
 822                 sa6.sin6_port = htons (123);
 823                 memcpy (&sa6.sin6_addr, &peer_info->srcadr6,
 824                                 sizeof (struct in6_addr));
 825                 sa_len = sizeof (sa6);
 826
 827                 memcpy (&sa, &sa6, sizeof (sa6));
 828         }
 829         else
 830         {
 831                 struct sockaddr_in sa4;
 832
 833                 assert (sizeof (sa) >= sizeof (sa4));
 834
 835                 memset (&sa4, 0, sizeof (sa4));
 836                 sa4.sin_family = AF_INET;
 837                 sa4.sin_port = htons (123);
 838                 memcpy (&sa4.sin_addr, &peer_info->srcadr,
 839                                 sizeof (struct in_addr));
 840                 sa_len = sizeof (sa4);
 841
 842                 memcpy (&sa, &sa4, sizeof (sa4));
 843         }
 844
 845         if (!do_reverse_lookup)
 846                 flags |= NI_NUMERICHOST;
 847
 848         status = getnameinfo ((struct sockaddr const *) &sa, sa_len,
 849                         buffer, buffer_size,
 850                         NULL, 0, /* No port name */
 851                         flags);
 852         if (status != 0)
 853         {
 854                 char errbuf[1024];
 855                 ERROR ("ntpd plugin: getnameinfo failed: %s",
 856                                 (status == EAI_SYSTEM)
 857                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 858                                 : gai_strerror (status));
 859                 return (-1);
 860         }
 861
 862         return (0);
 863 } /* ntpd_get_name_from_address */
 864
 865 static int ntpd_get_name_refclock (char *buffer, size_t buffer_size,
 866                 struct info_peer_summary const *peer_info)
 867 {
 868         uint32_t refclock_id = ntpd_get_refclock_id (peer_info);
 869         uint32_t unit_id = ntohl (peer_info->srcadr) & 0x00FF;
 870
 871         if (refclock_id >= refclock_names_num)
 872                 return (ntpd_get_name_from_address (buffer, buffer_size,
 873                                         peer_info,
 874                                         /* do_reverse_lookup = */ 0));
 875
 876         if (include_unit_id)
 877                 ssnprintf (buffer, buffer_size, "%s-%"PRIu32,
 878                                 refclock_names[refclock_id], unit_id);
 879         else
 880                 sstrncpy (buffer, refclock_names[refclock_id], buffer_size);
 881
 882         return (0);
 883 } /* int ntpd_get_name_refclock */
 884
 885 static int ntpd_get_name (char *buffer, size_t buffer_size,
 886                 struct info_peer_summary const *peer_info)
 887 {
 888         uint32_t addr = ntohl (peer_info->srcadr);
 889
 890         if (!peer_info->v6_flag && ((addr & REFCLOCK_MASK) == REFCLOCK_ADDR))
 891                 return (ntpd_get_name_refclock (buffer, buffer_size,
 892                                         peer_info));
 893         else
 894                 return (ntpd_get_name_from_address (buffer, buffer_size,
 895                                         peer_info, do_reverse_lookups));
 896 } /* int ntpd_addr_to_name */
 897
 898 static int ntpd_read (void)
 899 {
 900         struct info_kernel *ik;
 901         int                 ik_num;
 902         int                 ik_size;
 903
 904         struct info_peer_summary *ps;
 905         int                       ps_num;
 906         int                       ps_size;
 907
 908         int status;
 909         int i;
 910
 911         ik      = NULL;
 912         ik_num  = 0;
 913         ik_size = 0;
 914
 915         status = ntpd_do_query (REQ_GET_KERNEL,
 916                         0, 0, NULL, /* request data */
 917                         &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
 918                         sizeof (struct info_kernel));
 919         if (status != 0)
 920         {
 921                 ERROR ("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", status);
 922                 return (status);
 923         }
 924         else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
 925         {
 926                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
 927                                 "(ik = %p; ik_num = %i; ik_size = %i)",
 928                                 (void *) ik, ik_num, ik_size);
 929                 return (-1);
 930         }
 931
 932         /* kerninfo -> estimated error */
 933
 934         DEBUG ("info_kernel:\n"
 935                         "  pll offset    = %.8f\n"
 936                         "  pll frequency = %.8f\n" /* drift compensation */
 937                         "  est error     = %.8f\n",
 938                         ntpd_read_fp (ik->offset),
 939                         ntpd_read_fp (ik->freq),
 940                         ntpd_read_fp (ik->esterror));
 941
 942         ntpd_submit ("frequency_offset", "loop",  ntpd_read_fp (ik->freq));
 943         ntpd_submit ("time_offset",      "loop",  ntpd_read_fp (ik->offset));
 944         ntpd_submit ("time_offset",      "error", ntpd_read_fp (ik->esterror));
 945
 946         free (ik);
 947         ik = NULL;
 948
 949         status = ntpd_do_query (REQ_PEER_LIST_SUM,
 950                         0, 0, NULL, /* request data */
 951                         &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
 952                         sizeof (struct info_peer_summary));
 953         if (status != 0)
 954         {
 955                 ERROR ("ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", status);
 956                 return (status);
 957         }
 958         else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
 959         {
 960                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
 961                                 "(ps = %p; ps_num = %i; ps_size = %i)",
 962                                 (void *) ps, ps_num, ps_size);
 963                 return (-1);
 964         }
 965
 966         for (i = 0; i < ps_num; i++)
 967         {
 968                 struct info_peer_summary *ptr;
 969                 double offset;
 970
 971                 char peername[NI_MAXHOST];
 972                 uint32_t refclock_id;
 973
 974                 ptr = ps + i;
 975
 976                 status = ntpd_get_name (peername, sizeof (peername), ptr);
 977                 if (status != 0)
 978                 {
 979                         ERROR ("ntpd plugin: Determining name of peer failed.");
 980                         continue;
 981                 }
 982
 983                 refclock_id = ntpd_get_refclock_id (ptr);
 984
 985                 /* Convert the `long floating point' offset value to double */
 986                 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
 987
 988                 DEBUG ("peer %i:\n"
 989                                 "  peername   = %s\n"
 990                                 "  srcadr     = 0x%08x\n"
 991                                 "  reach      = 0%03o\n"
 992                                 "  delay      = %f\n"
 993                                 "  offset_int = %i\n"
 994                                 "  offset_frc = %i\n"
 995                                 "  offset     = %f\n"
 996                                 "  dispersion = %f\n",
 997                                 i,
 998                                 peername,
 999                                 ntohl (ptr->srcadr),
1000                                 ptr->reach,
1001                                 ntpd_read_fp (ptr->delay),
1002                                 ntohl (ptr->offset_int),
1003                                 ntohl (ptr->offset_frc),
1004                                 offset,
1005                                 ntpd_read_fp (ptr->dispersion));
1006
1007                 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
1008                         ntpd_submit_reach ("time_offset", peername, ptr->reach,
1009                                         offset);
1010                 ntpd_submit_reach ("time_dispersion", peername, ptr->reach,
1011                                 ntpd_read_fp (ptr->dispersion));
1012                 if (refclock_id == 0) /* not a reference clock */
1013                         ntpd_submit_reach ("delay", peername, ptr->reach,
1014                                         ntpd_read_fp (ptr->delay));
1015         }
1016
1017         free (ps);
1018         ps = NULL;
1019
1020         return (0);
1021 } /* int ntpd_read */
1022
1023 void module_register (void)
1024 {
1025         plugin_register_config ("ntpd", ntpd_config,
1026                         config_keys, config_keys_num);
1027         plugin_register_read ("ntpd", ntpd_read);
1028 } /* void module_register */