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