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