1 /**
2 * collectd - src/ntpd.c
3 * Copyright (C) 2006-2012 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 **/
27 #define _DEFAULT_SOURCE
28 #define _BSD_SOURCE /* For NI_MAXHOST */
30 #include "collectd.h"
32 #include "common.h"
33 #include "plugin.h"
34 #include "configfile.h"
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_NETINET_IN_H
43 # include <netinet/in.h>
44 #endif
45 #if HAVE_ARPA_INET_H
46 # include <arpa/inet.h> /* inet_ntoa */
47 #endif
48 #if HAVE_NETINET_TCP_H
49 # include <netinet/tcp.h>
50 #endif
51 #if HAVE_POLL_H
52 # include <poll.h>
53 #endif
55 #ifndef STA_NANO
56 # define STA_NANO 0x2000
57 #endif
59 static const char *config_keys[] =
60 {
61 "Host",
62 "Port",
63 "ReverseLookups",
64 "IncludeUnitID"
65 };
66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
68 static _Bool do_reverse_lookups = 1;
70 /* This option only exists for backward compatibility. If it is false and two
71 * ntpd peers use the same refclock driver, the plugin will try to write
72 * simultaneous measurements from both to the same type instance. */
73 static _Bool include_unit_id = 0;
75 # define NTPD_DEFAULT_HOST "localhost"
76 # define NTPD_DEFAULT_PORT "123"
77 static int sock_descr = -1;
78 static char *ntpd_host = NULL;
79 static char ntpd_port[16];
81 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
82 * The following definitions were copied from the NTPd distribution *
83 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
84 #define MAXFILENAME 128
85 #define MAXSEQ 127
86 #define MODE_PRIVATE 7
87 #define NTP_OLDVERSION ((uint8_t) 1) /* oldest credible version */
88 #define IMPL_XNTPD 3
89 #define FP_FRAC 65536.0
91 #define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */
92 #define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */
94 /* This structure is missing the message authentication code, since collectd
95 * doesn't use it. */
96 struct req_pkt
97 {
98 uint8_t rm_vn_mode;
99 uint8_t auth_seq;
100 uint8_t implementation; /* implementation number */
101 uint8_t request; /* request number */
102 uint16_t err_nitems; /* error code/number of data items */
103 uint16_t mbz_itemsize; /* item size */
104 char data[MAXFILENAME + 48]; /* data area [32 prev](176 byte max) */
105 /* struct conf_peer must fit */
106 };
107 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
109 /*
110 * A response packet. The length here is variable, this is a
111 * maximally sized one. Note that this implementation doesn't
112 * authenticate responses.
113 */
114 #define RESP_HEADER_SIZE (8)
115 #define RESP_DATA_SIZE (500)
117 struct resp_pkt
118 {
119 uint8_t rm_vn_mode; /* response, more, version, mode */
120 uint8_t auth_seq; /* key, sequence number */
121 uint8_t implementation; /* implementation number */
122 uint8_t request; /* request number */
123 uint16_t err_nitems; /* error code/number of data items */
124 uint16_t mbz_itemsize; /* item size */
125 char data[RESP_DATA_SIZE]; /* data area */
126 };
128 /*
129 * Bit setting macros for multifield items.
130 */
131 #define RESP_BIT 0x80
132 #define MORE_BIT 0x40
134 #define ISRESPONSE(rm_vn_mode) (((rm_vn_mode)&RESP_BIT)!=0)
135 #define ISMORE(rm_vn_mode) (((rm_vn_mode)&MORE_BIT)!=0)
136 #define INFO_VERSION(rm_vn_mode) ((uint8_t)(((rm_vn_mode)>>3)&0x7))
137 #define INFO_MODE(rm_vn_mode) ((rm_vn_mode)&0x7)
139 #define RM_VN_MODE(resp, more, version) \
140 ((uint8_t)(((resp)?RESP_BIT:0)\
141 |((more)?MORE_BIT:0)\
142 |((version?version:(NTP_OLDVERSION+1))<<3)\
143 |(MODE_PRIVATE)))
145 #define INFO_IS_AUTH(auth_seq) (((auth_seq) & 0x80) != 0)
146 #define INFO_SEQ(auth_seq) ((auth_seq)&0x7f)
147 #define AUTH_SEQ(auth, seq) ((uint8_t)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
149 #define INFO_ERR(err_nitems) ((uint16_t)((ntohs(err_nitems)>>12)&0xf))
150 #define INFO_NITEMS(err_nitems) ((uint16_t)(ntohs(err_nitems)&0xfff))
151 #define ERR_NITEMS(err, nitems) (htons((uint16_t)((((uint16_t)(err)<<12)&0xf000)\
152 |((uint16_t)(nitems)&0xfff))))
154 #define INFO_MBZ(mbz_itemsize) ((ntohs(mbz_itemsize)>>12)&0xf)
155 #define INFO_ITEMSIZE(mbz_itemsize) ((uint16_t)(ntohs(mbz_itemsize)&0xfff))
156 #define MBZ_ITEMSIZE(itemsize) (htons((uint16_t)(itemsize)))
158 /* negate a long float type */
159 #define M_NEG(v_i, v_f) \
160 do { \
161 if ((v_f) == 0) \
162 (v_i) = -((uint32_t)(v_i)); \
163 else { \
164 (v_f) = -((uint32_t)(v_f)); \
165 (v_i) = ~(v_i); \
166 } \
167 } while(0)
168 /* l_fp to double */
169 #define M_LFPTOD(r_i, r_uf, d) \
170 do { \
171 register int32_t ri; \
172 register uint32_t rf; \
173 \
174 ri = (r_i); \
175 rf = (r_uf); \
176 if (ri < 0) { \
177 M_NEG(ri, rf); \
178 (d) = -((double) ri + ((double) rf) / 4294967296.0); \
179 } else { \
180 (d) = (double) ri + ((double) rf) / 4294967296.0; \
181 } \
182 } while (0)
184 #define REQ_PEER_LIST_SUM 1
185 struct info_peer_summary
186 {
187 uint32_t dstadr; /* local address (zero for undetermined) */
188 uint32_t srcadr; /* source address */
189 uint16_t srcport; /* source port */
190 uint8_t stratum; /* stratum of peer */
191 int8_t hpoll; /* host polling interval */
192 int8_t ppoll; /* peer polling interval */
193 uint8_t reach; /* reachability register */
194 uint8_t flags; /* flags, from above */
195 uint8_t hmode; /* peer mode */
196 int32_t delay; /* peer.estdelay; s_fp */
197 int32_t offset_int; /* peer.estoffset; integral part */
198 int32_t offset_frc; /* peer.estoffset; fractional part */
199 uint32_t dispersion; /* peer.estdisp; u_fp */
200 uint32_t v6_flag; /* is this v6 or not */
201 uint32_t unused1; /* (unused) padding for dstadr6 */
202 struct in6_addr dstadr6; /* local address (v6) */
203 struct in6_addr srcadr6; /* source address (v6) */
204 };
206 #define REQ_SYS_INFO 4
207 struct info_sys
208 {
209 uint32_t peer; /* system peer address (v4) */
210 uint8_t peer_mode; /* mode we are syncing to peer in */
211 uint8_t leap; /* system leap bits */
212 uint8_t stratum; /* our stratum */
213 int8_t precision; /* local clock precision */
214 int32_t rootdelay; /* distance from sync source */
215 uint32_t rootdispersion; /* dispersion from sync source */
216 uint32_t refid; /* reference ID of sync source */
217 uint64_t reftime; /* system reference time */
218 uint32_t poll; /* system poll interval */
219 uint8_t flags; /* system flags */
220 uint8_t unused1; /* unused */
221 uint8_t unused2; /* unused */
222 uint8_t unused3; /* unused */
223 int32_t bdelay; /* default broadcast offset */
224 int32_t frequency; /* frequency residual (scaled ppm) */
225 uint64_t authdelay; /* default authentication delay */
226 uint32_t stability; /* clock stability (scaled ppm) */
227 int32_t v6_flag; /* is this v6 or not */
228 int32_t unused4; /* unused, padding for peer6 */
229 struct in6_addr peer6; /* system peer address (v6) */
230 };
232 #define REQ_GET_KERNEL 38
233 struct info_kernel
234 {
235 int32_t offset;
236 int32_t freq;
237 int32_t maxerror;
238 int32_t esterror;
239 uint16_t status;
240 uint16_t shift;
241 int32_t constant;
242 int32_t precision;
243 int32_t tolerance;
244 /* pps stuff */
245 int32_t ppsfreq;
246 int32_t jitter;
247 int32_t stabil;
248 int32_t jitcnt;
249 int32_t calcnt;
250 int32_t errcnt;
251 int32_t stbcnt;
252 };
254 /* List of reference clock names */
255 static const char *refclock_names[] =
256 {
257 "UNKNOWN", "LOCAL", "GPS_TRAK", "WWV_PST", /* 0- 3 */
258 "SPECTRACOM", "TRUETIME", "IRIG_AUDIO", "CHU_AUDIO", /* 4- 7 */
259 "GENERIC", "GPS_MX4200", "GPS_AS2201", "GPS_ARBITER", /* 8-11 */
260 "IRIG_TPRO", "ATOM_LEITCH", "MSF_EES", "GPSTM_TRUE", /* 12-15 */
261 "GPS_BANC", "GPS_DATUM", "ACTS_NIST", "WWV_HEATH", /* 16-19 */
262 "GPS_NMEA", "GPS_VME", "PPS", "ACTS_PTB", /* 20-23 */
263 "ACTS_USNO", "TRUETIME", "GPS_HP", "MSF_ARCRON", /* 24-27 */
264 "SHM", "GPS_PALISADE", "GPS_ONCORE", "GPS_JUPITER", /* 28-31 */
265 "CHRONOLOG", "DUMBCLOCK", "ULINK_M320", "PCF", /* 32-35 */
266 "WWV_AUDIO", "GPS_FG", "HOPF_S", "HOPF_P", /* 36-39 */
267 "JJY", "TT_IRIG", "GPS_ZYFER", "GPS_RIPENCC", /* 40-43 */
268 "NEOCLK4X" /* 44 */
269 };
270 static size_t refclock_names_num = STATIC_ARRAY_SIZE (refclock_names);
271 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
272 * End of the copied stuff.. *
273 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
275 static int ntpd_config (const char *key, const char *value)
276 {
277 if (strcasecmp (key, "Host") == 0)
278 {
279 if (ntpd_host != NULL)
280 free (ntpd_host);
281 if ((ntpd_host = strdup (value)) == NULL)
282 return (1);
283 }
284 else if (strcasecmp (key, "Port") == 0)
285 {
286 int port = (int) (atof (value));
287 if ((port > 0) && (port <= 65535))
288 ssnprintf (ntpd_port, sizeof (ntpd_port),
289 "%i", port);
290 else
291 sstrncpy (ntpd_port, value, sizeof (ntpd_port));
292 }
293 else if (strcasecmp (key, "ReverseLookups") == 0)
294 {
295 if (IS_TRUE (value))
296 do_reverse_lookups = 1;
297 else
298 do_reverse_lookups = 0;
299 }
300 else if (strcasecmp (key, "IncludeUnitID") == 0)
301 {
302 if (IS_TRUE (value))
303 include_unit_id = 1;
304 else
305 include_unit_id = 0;
306 }
307 else
308 {
309 return (-1);
310 }
312 return (0);
313 }
315 static void ntpd_submit (const char *type, const char *type_inst, gauge_t value)
316 {
317 value_t values[1];
318 value_list_t vl = VALUE_LIST_INIT;
320 values[0].gauge = value;
322 vl.values = values;
323 vl.values_len = 1;
324 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
325 sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
326 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
327 sstrncpy (vl.type, type, sizeof (vl.type));
328 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
330 plugin_dispatch_values (&vl);
331 }
333 /* Each time a peer is polled, ntpd shifts the reach register to the left and
334 * sets the LSB based on whether the peer was reachable. If the LSB is zero,
335 * the values are out of date. */
336 static void ntpd_submit_reach (const char *type, const char *type_inst,
337 uint8_t reach, gauge_t value)
338 {
339 if (!(reach & 1))
340 value = NAN;
342 ntpd_submit (type, type_inst, value);
343 }
345 static int ntpd_connect (void)
346 {
347 const char *host;
348 const char *port;
350 struct addrinfo *ai_list;
351 int status;
353 if (sock_descr >= 0)
354 return (sock_descr);
356 DEBUG ("Opening a new socket");
358 host = ntpd_host;
359 if (host == NULL)
360 host = NTPD_DEFAULT_HOST;
362 port = ntpd_port;
363 if (strlen (port) == 0)
364 port = NTPD_DEFAULT_PORT;
366 struct addrinfo ai_hints = {
367 .ai_family = AF_UNSPEC,
368 .ai_flags = AI_ADDRCONFIG,
369 .ai_protocol = IPPROTO_UDP,
370 .ai_socktype = SOCK_DGRAM
371 };
373 if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
374 {
375 char errbuf[1024];
376 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
377 host, port,
378 (status == EAI_SYSTEM)
379 ? sstrerror (errno, errbuf, sizeof (errbuf))
380 : gai_strerror (status));
381 return (-1);
382 }
384 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
385 {
386 /* create our socket descriptor */
387 if ((sock_descr = socket (ai_ptr->ai_family,
388 ai_ptr->ai_socktype,
389 ai_ptr->ai_protocol)) < 0)
390 continue;
392 /* connect to the ntpd */
393 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
394 {
395 close (sock_descr);
396 sock_descr = -1;
397 continue;
398 }
400 break;
401 }
403 freeaddrinfo (ai_list);
405 if (sock_descr < 0)
406 {
407 ERROR ("ntpd plugin: Unable to connect to server.");
408 }
410 return (sock_descr);
411 }
413 /* For a description of the arguments see `ntpd_do_query' below. */
414 static int ntpd_receive_response (int *res_items, int *res_size,
415 char **res_data, int res_item_size)
416 {
417 int sd;
418 struct pollfd poll_s;
419 struct resp_pkt res;
420 int status;
421 int done;
423 char *items;
424 size_t items_num;
426 struct timeval time_end;
427 struct timeval time_now;
428 int timeout;
430 int pkt_item_num; /* items in this packet */
431 int pkt_item_len; /* size of the items in this packet */
432 int pkt_sequence;
433 char pkt_recvd[MAXSEQ+1] = { 0 }; /* sequence numbers that have been received */
434 int pkt_recvd_num; /* number of packets that have been received */
435 int pkt_lastseq; /* the last sequence number */
436 ssize_t pkt_padding; /* Padding in this packet */
438 if ((sd = ntpd_connect ()) < 0)
439 return (-1);
441 items = NULL;
442 items_num = 0;
444 pkt_recvd_num = 0;
445 pkt_lastseq = -1;
447 *res_items = 0;
448 *res_size = 0;
449 *res_data = NULL;
451 if (gettimeofday (&time_end, NULL) < 0)
452 {
453 char errbuf[1024];
454 ERROR ("ntpd plugin: gettimeofday failed: %s",
455 sstrerror (errno, errbuf, sizeof (errbuf)));
456 return (-1);
457 }
458 time_end.tv_sec++; /* wait for a most one second */
460 done = 0;
461 while (done == 0)
462 {
463 struct timeval time_left;
465 if (gettimeofday (&time_now, NULL) < 0)
466 {
467 char errbuf[1024];
468 ERROR ("ntpd plugin: gettimeofday failed: %s",
469 sstrerror (errno, errbuf, sizeof (errbuf)));
470 return (-1);
471 }
473 if (timeval_cmp (time_end, time_now, &time_left) <= 0)
474 timeout = 0;
475 else
476 timeout = 1000 * time_left.tv_sec
477 + ((time_left.tv_usec + 500) / 1000);
479 /* timeout reached */
480 if (timeout <= 0)
481 break;
483 poll_s.fd = sd;
484 poll_s.events = POLLIN | POLLPRI;
485 poll_s.revents = 0;
487 DEBUG ("Polling for %ims", timeout);
488 status = poll (&poll_s, 1, timeout);
490 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
491 continue;
493 if (status < 0)
494 {
495 char errbuf[1024];
496 ERROR ("ntpd plugin: poll failed: %s",
497 sstrerror (errno, errbuf, sizeof (errbuf)));
498 return (-1);
499 }
501 if (status == 0) /* timeout */
502 {
503 DEBUG ("timeout reached.");
504 break;
505 }
507 memset (&res, '\0', sizeof (res));
508 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
510 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
511 continue;
513 if (status < 0)
514 {
515 char errbuf[1024];
516 INFO ("recv(2) failed: %s",
517 sstrerror (errno, errbuf, sizeof (errbuf)));
518 DEBUG ("Closing socket #%i", sd);
519 close (sd);
520 sock_descr = sd = -1;
521 return (-1);
522 }
524 DEBUG ("recv'd %i bytes", status);
526 /*
527 * Do some sanity checks first
528 */
529 if (status < RESP_HEADER_SIZE)
530 {
531 WARNING ("ntpd plugin: Short (%i bytes) packet received",
532 (int) status);
533 continue;
534 }
535 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
536 {
537 NOTICE ("ntpd plugin: Packet received with mode %i",
538 INFO_MODE (res.rm_vn_mode));
539 continue;
540 }
541 if (INFO_IS_AUTH (res.auth_seq))
542 {
543 NOTICE ("ntpd plugin: Encrypted packet received");
544 continue;
545 }
546 if (!ISRESPONSE (res.rm_vn_mode))
547 {
548 NOTICE ("ntpd plugin: Received request packet, "
549 "wanted response");
550 continue;
551 }
552 if (INFO_MBZ (res.mbz_itemsize))
553 {
554 WARNING ("ntpd plugin: Received packet with nonzero "
555 "MBZ field!");
556 continue;
557 }
558 if (res.implementation != IMPL_XNTPD)
559 {
560 WARNING ("ntpd plugin: Asked for request of type %i, "
561 "got %i", (int) IMPL_XNTPD, (int) res.implementation);
562 continue;
563 }
565 /* Check for error code */
566 if (INFO_ERR (res.err_nitems) != 0)
567 {
568 ERROR ("ntpd plugin: Received error code %i",
569 (int) INFO_ERR(res.err_nitems));
570 return ((int) INFO_ERR (res.err_nitems));
571 }
573 /* extract number of items in this packet and the size of these items */
574 pkt_item_num = INFO_NITEMS (res.err_nitems);
575 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
576 DEBUG ("pkt_item_num = %i; pkt_item_len = %i;",
577 pkt_item_num, pkt_item_len);
579 /* Check if the reported items fit in the packet */
580 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
581 {
582 ERROR ("ntpd plugin: %i items * %i bytes > "
583 "%i bytes - %i bytes header",
584 (int) pkt_item_num, (int) pkt_item_len,
585 (int) status, (int) RESP_HEADER_SIZE);
586 continue;
587 }
589 if (pkt_item_len > res_item_size)
590 {
591 ERROR ("ntpd plugin: (pkt_item_len = %i) "
592 ">= (res_item_size = %i)",
593 pkt_item_len, res_item_size);
594 continue;
595 }
597 /* If this is the first packet (time wise, not sequence wise),
598 * set `res_size'. If it's not the first packet check if the
599 * items have the same size. Discard invalid packets. */
600 if (items_num == 0) /* first packet */
601 {
602 DEBUG ("*res_size = %i", pkt_item_len);
603 *res_size = pkt_item_len;
604 }
605 else if (*res_size != pkt_item_len)
606 {
607 DEBUG ("Error: *res_size = %i; pkt_item_len = %i;",
608 *res_size, pkt_item_len);
609 ERROR ("Item sizes differ.");
610 continue;
611 }
613 /*
614 * Because the items in the packet may be smaller than the
615 * items requested, the following holds true:
616 */
617 assert ((*res_size == pkt_item_len)
618 && (pkt_item_len <= res_item_size));
620 /* Calculate the padding. No idea why there might be any padding.. */
621 pkt_padding = 0;
622 if (pkt_item_len < res_item_size)
623 pkt_padding = res_item_size - pkt_item_len;
624 DEBUG ("res_item_size = %i; pkt_padding = %zi;",
625 res_item_size, pkt_padding);
627 /* Extract the sequence number */
628 pkt_sequence = INFO_SEQ (res.auth_seq);
629 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
630 {
631 ERROR ("ntpd plugin: Received packet with sequence %i",
632 pkt_sequence);
633 continue;
634 }
636 /* Check if this sequence has been received before. If so, discard it. */
637 if (pkt_recvd[pkt_sequence] != '\0')
638 {
639 NOTICE ("ntpd plugin: Sequence %i received twice",
640 pkt_sequence);
641 continue;
642 }
644 /* If `pkt_lastseq != -1' another packet without `more bit' has
645 * been received. */
646 if (!ISMORE (res.rm_vn_mode))
647 {
648 if (pkt_lastseq != -1)
649 {
650 ERROR ("ntpd plugin: Two packets which both "
651 "claim to be the last one in the "
652 "sequence have been received.");
653 continue;
654 }
655 pkt_lastseq = pkt_sequence;
656 DEBUG ("Last sequence = %i;", pkt_lastseq);
657 }
659 /*
660 * Enough with the checks. Copy the data now.
661 * We start by allocating some more memory.
662 */
663 DEBUG ("realloc (%p, %zu)", (void *) *res_data,
664 (items_num + pkt_item_num) * res_item_size);
665 items = realloc (*res_data,
666 (items_num + pkt_item_num) * res_item_size);
667 if (items == NULL)
668 {
669 ERROR ("ntpd plugin: realloc failed.");
670 continue;
671 }
672 items_num += pkt_item_num;
673 *res_data = items;
675 for (int i = 0; i < pkt_item_num; i++)
676 {
677 /* dst: There are already `*res_items' items with
678 * res_item_size bytes each in in `*res_data'. Set
679 * dst to the first byte after that. */
680 void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
681 /* src: We use `pkt_item_len' to calculate the offset
682 * from the beginning of the packet, because the
683 * items in the packet may be smaller than the
684 * items that were requested. We skip `i' such
685 * items. */
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 /* Increment `*res_items' by one, so `dst' will end up
694 * one further in the next round. */
695 (*res_items)++;
696 } /* for (pkt_item_num) */
698 pkt_recvd[pkt_sequence] = (char) 1;
699 pkt_recvd_num++;
701 if ((pkt_recvd_num - 1) == pkt_lastseq)
702 done = 1;
703 } /* while (done == 0) */
705 return (0);
706 } /* int ntpd_receive_response */
708 /* For a description of the arguments see `ntpd_do_query' below. */
709 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
710 {
711 int sd;
712 struct req_pkt req = { 0 };
713 size_t req_data_len;
714 int status;
716 assert (req_items >= 0);
717 assert (req_size >= 0);
719 if ((sd = ntpd_connect ()) < 0)
720 return (-1);
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 = { 0 };
803 socklen_t sa_len;
804 int flags = 0;
805 int status;
807 if (peer_info->v6_flag)
808 {
809 struct sockaddr_in6 sa6 = { 0 };
811 assert (sizeof (sa) >= sizeof (sa6));
813 sa6.sin6_family = AF_INET6;
814 sa6.sin6_port = htons (123);
815 memcpy (&sa6.sin6_addr, &peer_info->srcadr6,
816 sizeof (struct in6_addr));
817 sa_len = sizeof (sa6);
819 memcpy (&sa, &sa6, sizeof (sa6));
820 }
821 else
822 {
823 struct sockaddr_in sa4 = { 0 };
825 assert (sizeof (sa) >= sizeof (sa4));
827 sa4.sin_family = AF_INET;
828 sa4.sin_port = htons (123);
829 memcpy (&sa4.sin_addr, &peer_info->srcadr,
830 sizeof (struct in_addr));
831 sa_len = sizeof (sa4);
833 memcpy (&sa, &sa4, sizeof (sa4));
834 }
836 if (!do_reverse_lookup)
837 flags |= NI_NUMERICHOST;
839 status = getnameinfo ((struct sockaddr const *) &sa, sa_len,
840 buffer, buffer_size,
841 NULL, 0, /* No port name */
842 flags);
843 if (status != 0)
844 {
845 char errbuf[1024];
846 ERROR ("ntpd plugin: getnameinfo failed: %s",
847 (status == EAI_SYSTEM)
848 ? sstrerror (errno, errbuf, sizeof (errbuf))
849 : gai_strerror (status));
850 return (-1);
851 }
853 return (0);
854 } /* ntpd_get_name_from_address */
856 static int ntpd_get_name_refclock (char *buffer, size_t buffer_size,
857 struct info_peer_summary const *peer_info)
858 {
859 uint32_t refclock_id = ntpd_get_refclock_id (peer_info);
860 uint32_t unit_id = ntohl (peer_info->srcadr) & 0x00FF;
862 if (((size_t) refclock_id) >= refclock_names_num)
863 return (ntpd_get_name_from_address (buffer, buffer_size,
864 peer_info,
865 /* do_reverse_lookup = */ 0));
867 if (include_unit_id)
868 ssnprintf (buffer, buffer_size, "%s-%"PRIu32,
869 refclock_names[refclock_id], unit_id);
870 else
871 sstrncpy (buffer, refclock_names[refclock_id], buffer_size);
873 return (0);
874 } /* int ntpd_get_name_refclock */
876 static int ntpd_get_name (char *buffer, size_t buffer_size,
877 struct info_peer_summary const *peer_info)
878 {
879 uint32_t addr = ntohl (peer_info->srcadr);
881 if (!peer_info->v6_flag && ((addr & REFCLOCK_MASK) == REFCLOCK_ADDR))
882 return (ntpd_get_name_refclock (buffer, buffer_size,
883 peer_info));
884 else
885 return (ntpd_get_name_from_address (buffer, buffer_size,
886 peer_info, do_reverse_lookups));
887 } /* int ntpd_addr_to_name */
889 static int ntpd_read (void)
890 {
891 struct info_kernel *ik;
892 int ik_num;
893 int ik_size;
895 struct info_peer_summary *ps;
896 int ps_num;
897 int ps_size;
899 gauge_t offset_loop;
900 gauge_t freq_loop;
901 gauge_t offset_error;
903 int status;
905 /* On Linux, if the STA_NANO bit is set in ik->status, then ik->offset
906 * is is nanoseconds, otherwise it's microseconds. */
907 double scale_loop = 1e-6;
908 double scale_error = 1e-6;
910 ik = NULL;
911 ik_num = 0;
912 ik_size = 0;
914 status = ntpd_do_query (REQ_GET_KERNEL,
915 0, 0, NULL, /* request data */
916 &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
917 sizeof (struct info_kernel));
918 if (status != 0)
919 {
920 ERROR ("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", status);
921 return (status);
922 }
923 else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
924 {
925 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
926 "(ik = %p; ik_num = %i; ik_size = %i)",
927 (void *) ik, ik_num, ik_size);
928 return (-1);
929 }
931 if (ntohs(ik->status) & STA_NANO) {
932 scale_loop = 1e-9;
933 scale_error = 1e-9;
934 }
936 /* kerninfo -> estimated error */
937 offset_loop = scale_loop * ((gauge_t) ntohl (ik->offset));
938 freq_loop = ntpd_read_fp (ik->freq);
939 offset_error = scale_error * ((gauge_t) ntohl (ik->esterror));
941 DEBUG ("info_kernel:\n"
942 " pll offset = %.8g\n"
943 " pll frequency = %.8g\n" /* drift compensation */
944 " est error = %.8g\n",
945 offset_loop, freq_loop, offset_error);
947 ntpd_submit ("frequency_offset", "loop", freq_loop);
948 ntpd_submit ("time_offset", "loop", offset_loop);
949 ntpd_submit ("time_offset", "error", offset_error);
951 free (ik);
952 ik = NULL;
954 status = ntpd_do_query (REQ_PEER_LIST_SUM,
955 0, 0, NULL, /* request data */
956 &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
957 sizeof (struct info_peer_summary));
958 if (status != 0)
959 {
960 ERROR ("ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", status);
961 return (status);
962 }
963 else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
964 {
965 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
966 "(ps = %p; ps_num = %i; ps_size = %i)",
967 (void *) ps, ps_num, ps_size);
968 return (-1);
969 }
971 for (int i = 0; i < ps_num; i++)
972 {
973 struct info_peer_summary *ptr;
974 double offset;
976 char peername[NI_MAXHOST];
977 uint32_t refclock_id;
979 ptr = ps + i;
981 status = ntpd_get_name (peername, sizeof (peername), ptr);
982 if (status != 0)
983 {
984 ERROR ("ntpd plugin: Determining name of peer failed.");
985 continue;
986 }
988 refclock_id = ntpd_get_refclock_id (ptr);
990 /* Convert the `long floating point' offset value to double */
991 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
993 DEBUG ("peer %i:\n"
994 " peername = %s\n"
995 " srcadr = 0x%08x\n"
996 " reach = 0%03o\n"
997 " delay = %f\n"
998 " offset_int = %i\n"
999 " offset_frc = %i\n"
1000 " offset = %f\n"
1001 " dispersion = %f\n",
1002 i,
1003 peername,
1004 ntohl (ptr->srcadr),
1005 ptr->reach,
1006 ntpd_read_fp (ptr->delay),
1007 ntohl (ptr->offset_int),
1008 ntohl (ptr->offset_frc),
1009 offset,
1010 ntpd_read_fp (ptr->dispersion));
1012 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
1013 ntpd_submit_reach ("time_offset", peername, ptr->reach,
1014 offset);
1015 ntpd_submit_reach ("time_dispersion", peername, ptr->reach,
1016 ntpd_read_fp (ptr->dispersion));
1017 if (refclock_id == 0) /* not a reference clock */
1018 ntpd_submit_reach ("delay", peername, ptr->reach,
1019 ntpd_read_fp (ptr->delay));
1020 }
1022 free (ps);
1023 ps = NULL;
1025 return (0);
1026 } /* int ntpd_read */
1028 void module_register (void)
1029 {
1030 plugin_register_config ("ntpd", ntpd_config,
1031 config_keys, config_keys_num);
1032 plugin_register_read ("ntpd", ntpd_read);
1033 } /* void module_register */