src/ntpd.c

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