src/ntpd.c

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