Code

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