src/ntpd.c

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