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