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