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