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