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