2 * collectd - src/ntpd.c
3 * Copyright (C) 2006-2012 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
27 #define _DEFAULT_SOURCE
28 #define _BSD_SOURCE /* For NI_MAXHOST */
42 # include <netinet/in.h>
45 # include <arpa/inet.h> /* inet_ntoa */
47 #if HAVE_NETINET_TCP_H
48 # include <netinet/tcp.h>
55 # define STA_NANO 0x2000
58 static const char *config_keys[] =
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
85 #define MODE_PRIVATE 7
86 #define NTP_OLDVERSION ((uint8_t) 1) /* oldest credible version */
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
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 */
106 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
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.
113 #define RESP_HEADER_SIZE (8)
114 #define RESP_DATA_SIZE (500)
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 */
128 * Bit setting macros for multifield items.
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)\
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) \
161 (v_i) = -((uint32_t)(v_i)); \
163 (v_f) = -((uint32_t)(v_f)); \
168 #define M_LFPTOD(r_i, r_uf, d) \
170 register int32_t ri; \
171 register uint32_t rf; \
177 (d) = -((double) ri + ((double) rf) / 4294967296.0); \
179 (d) = (double) ri + ((double) rf) / 4294967296.0; \
183 #define REQ_PEER_LIST_SUM 1
184 struct info_peer_summary
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) */
205 #define REQ_SYS_INFO 4
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) */
231 #define REQ_GET_KERNEL 38
253 /* List of reference clock names */
254 static const char *refclock_names[] =
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 */
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)
276 if (strcasecmp (key, "Host") == 0)
278 if (ntpd_host != NULL)
280 if ((ntpd_host = strdup (value)) == NULL)
283 else if (strcasecmp (key, "Port") == 0)
285 int port = (int) (atof (value));
286 if ((port > 0) && (port <= 65535))
287 ssnprintf (ntpd_port, sizeof (ntpd_port),
290 sstrncpy (ntpd_port, value, sizeof (ntpd_port));
292 else if (strcasecmp (key, "ReverseLookups") == 0)
295 do_reverse_lookups = 1;
297 do_reverse_lookups = 0;
299 else if (strcasecmp (key, "IncludeUnitID") == 0)
314 static void ntpd_submit (const char *type, const char *type_inst, gauge_t value)
316 value_list_t vl = VALUE_LIST_INIT;
318 vl.values = &(value_t) { .gauge = value };
320 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
321 sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
322 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
323 sstrncpy (vl.type, type, sizeof (vl.type));
324 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
326 plugin_dispatch_values (&vl);
329 /* Each time a peer is polled, ntpd shifts the reach register to the left and
330 * sets the LSB based on whether the peer was reachable. If the LSB is zero,
331 * the values are out of date. */
332 static void ntpd_submit_reach (const char *type, const char *type_inst,
333 uint8_t reach, gauge_t value)
338 ntpd_submit (type, type_inst, value);
341 static int ntpd_connect (void)
346 struct addrinfo *ai_list;
352 DEBUG ("Opening a new socket");
356 host = NTPD_DEFAULT_HOST;
359 if (strlen (port) == 0)
360 port = NTPD_DEFAULT_PORT;
362 struct addrinfo ai_hints = {
363 .ai_family = AF_UNSPEC,
364 .ai_flags = AI_ADDRCONFIG,
365 .ai_protocol = IPPROTO_UDP,
366 .ai_socktype = SOCK_DGRAM
369 if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
372 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
374 (status == EAI_SYSTEM)
375 ? sstrerror (errno, errbuf, sizeof (errbuf))
376 : gai_strerror (status));
380 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
382 /* create our socket descriptor */
383 if ((sock_descr = socket (ai_ptr->ai_family,
385 ai_ptr->ai_protocol)) < 0)
388 /* connect to the ntpd */
389 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
399 freeaddrinfo (ai_list);
403 ERROR ("ntpd plugin: Unable to connect to server.");
409 /* For a description of the arguments see `ntpd_do_query' below. */
410 static int ntpd_receive_response (int *res_items, int *res_size,
411 char **res_data, int res_item_size)
414 struct pollfd poll_s;
422 struct timeval time_end;
423 struct timeval time_now;
426 int pkt_item_num; /* items in this packet */
427 int pkt_item_len; /* size of the items in this packet */
429 char pkt_recvd[MAXSEQ+1] = { 0 }; /* sequence numbers that have been received */
430 int pkt_recvd_num; /* number of packets that have been received */
431 int pkt_lastseq; /* the last sequence number */
432 ssize_t pkt_padding; /* Padding in this packet */
434 if ((sd = ntpd_connect ()) < 0)
447 if (gettimeofday (&time_end, NULL) < 0)
450 ERROR ("ntpd plugin: gettimeofday failed: %s",
451 sstrerror (errno, errbuf, sizeof (errbuf)));
454 time_end.tv_sec++; /* wait for a most one second */
459 struct timeval time_left;
461 if (gettimeofday (&time_now, NULL) < 0)
464 ERROR ("ntpd plugin: gettimeofday failed: %s",
465 sstrerror (errno, errbuf, sizeof (errbuf)));
469 if (timeval_cmp (time_end, time_now, &time_left) <= 0)
472 timeout = 1000 * time_left.tv_sec
473 + ((time_left.tv_usec + 500) / 1000);
475 /* timeout reached */
480 poll_s.events = POLLIN | POLLPRI;
483 DEBUG ("Polling for %ims", timeout);
484 status = poll (&poll_s, 1, timeout);
486 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
492 ERROR ("ntpd plugin: poll failed: %s",
493 sstrerror (errno, errbuf, sizeof (errbuf)));
497 if (status == 0) /* timeout */
499 DEBUG ("timeout reached.");
503 memset (&res, '\0', sizeof (res));
504 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
506 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
512 INFO ("recv(2) failed: %s",
513 sstrerror (errno, errbuf, sizeof (errbuf)));
514 DEBUG ("Closing socket #%i", sd);
516 sock_descr = sd = -1;
520 DEBUG ("recv'd %i bytes", status);
523 * Do some sanity checks first
525 if (status < RESP_HEADER_SIZE)
527 WARNING ("ntpd plugin: Short (%i bytes) packet received",
531 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
533 NOTICE ("ntpd plugin: Packet received with mode %i",
534 INFO_MODE (res.rm_vn_mode));
537 if (INFO_IS_AUTH (res.auth_seq))
539 NOTICE ("ntpd plugin: Encrypted packet received");
542 if (!ISRESPONSE (res.rm_vn_mode))
544 NOTICE ("ntpd plugin: Received request packet, "
548 if (INFO_MBZ (res.mbz_itemsize))
550 WARNING ("ntpd plugin: Received packet with nonzero "
554 if (res.implementation != IMPL_XNTPD)
556 WARNING ("ntpd plugin: Asked for request of type %i, "
557 "got %i", (int) IMPL_XNTPD, (int) res.implementation);
561 /* Check for error code */
562 if (INFO_ERR (res.err_nitems) != 0)
564 ERROR ("ntpd plugin: Received error code %i",
565 (int) INFO_ERR(res.err_nitems));
566 return ((int) INFO_ERR (res.err_nitems));
569 /* extract number of items in this packet and the size of these items */
570 pkt_item_num = INFO_NITEMS (res.err_nitems);
571 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
572 DEBUG ("pkt_item_num = %i; pkt_item_len = %i;",
573 pkt_item_num, pkt_item_len);
575 /* Check if the reported items fit in the packet */
576 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
578 ERROR ("ntpd plugin: %i items * %i bytes > "
579 "%i bytes - %i bytes header",
580 (int) pkt_item_num, (int) pkt_item_len,
581 (int) status, (int) RESP_HEADER_SIZE);
585 if (pkt_item_len > res_item_size)
587 ERROR ("ntpd plugin: (pkt_item_len = %i) "
588 ">= (res_item_size = %i)",
589 pkt_item_len, res_item_size);
593 /* If this is the first packet (time wise, not sequence wise),
594 * set `res_size'. If it's not the first packet check if the
595 * items have the same size. Discard invalid packets. */
596 if (items_num == 0) /* first packet */
598 DEBUG ("*res_size = %i", pkt_item_len);
599 *res_size = pkt_item_len;
601 else if (*res_size != pkt_item_len)
603 DEBUG ("Error: *res_size = %i; pkt_item_len = %i;",
604 *res_size, pkt_item_len);
605 ERROR ("Item sizes differ.");
610 * Because the items in the packet may be smaller than the
611 * items requested, the following holds true:
613 assert ((*res_size == pkt_item_len)
614 && (pkt_item_len <= res_item_size));
616 /* Calculate the padding. No idea why there might be any padding.. */
618 if (pkt_item_len < res_item_size)
619 pkt_padding = res_item_size - pkt_item_len;
620 DEBUG ("res_item_size = %i; pkt_padding = %zi;",
621 res_item_size, pkt_padding);
623 /* Extract the sequence number */
624 pkt_sequence = INFO_SEQ (res.auth_seq);
625 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
627 ERROR ("ntpd plugin: Received packet with sequence %i",
632 /* Check if this sequence has been received before. If so, discard it. */
633 if (pkt_recvd[pkt_sequence] != '\0')
635 NOTICE ("ntpd plugin: Sequence %i received twice",
640 /* If `pkt_lastseq != -1' another packet without `more bit' has
642 if (!ISMORE (res.rm_vn_mode))
644 if (pkt_lastseq != -1)
646 ERROR ("ntpd plugin: Two packets which both "
647 "claim to be the last one in the "
648 "sequence have been received.");
651 pkt_lastseq = pkt_sequence;
652 DEBUG ("Last sequence = %i;", pkt_lastseq);
656 * Enough with the checks. Copy the data now.
657 * We start by allocating some more memory.
659 DEBUG ("realloc (%p, %zu)", (void *) *res_data,
660 (items_num + pkt_item_num) * res_item_size);
661 items = realloc (*res_data,
662 (items_num + pkt_item_num) * res_item_size);
665 ERROR ("ntpd plugin: realloc failed.");
668 items_num += pkt_item_num;
671 for (int i = 0; i < pkt_item_num; i++)
673 /* dst: There are already `*res_items' items with
674 * res_item_size bytes each in in `*res_data'. Set
675 * dst to the first byte after that. */
676 void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
677 /* src: We use `pkt_item_len' to calculate the offset
678 * from the beginning of the packet, because the
679 * items in the packet may be smaller than the
680 * items that were requested. We skip `i' such
682 void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
684 /* Set the padding to zeros */
685 if (pkt_padding != 0)
686 memset (dst, '\0', res_item_size);
687 memcpy (dst, src, (size_t) pkt_item_len);
689 /* Increment `*res_items' by one, so `dst' will end up
690 * one further in the next round. */
692 } /* for (pkt_item_num) */
694 pkt_recvd[pkt_sequence] = (char) 1;
697 if ((pkt_recvd_num - 1) == pkt_lastseq)
699 } /* while (done == 0) */
702 } /* int ntpd_receive_response */
704 /* For a description of the arguments see `ntpd_do_query' below. */
705 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
708 struct req_pkt req = { 0 };
712 assert (req_items >= 0);
713 assert (req_size >= 0);
715 if ((sd = ntpd_connect ()) < 0)
718 req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
719 req.auth_seq = AUTH_SEQ (0, 0);
720 req.implementation = IMPL_XNTPD;
721 req.request = (unsigned char) req_code;
723 req_data_len = (size_t) (req_items * req_size);
725 assert (((req_data != NULL) && (req_data_len > 0))
726 || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
728 req.err_nitems = ERR_NITEMS (0, req_items);
729 req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
731 if (req_data != NULL)
732 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
734 DEBUG ("req_items = %i; req_size = %i; req_data = %p;",
735 req_items, req_size, (void *) req_data);
737 status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
740 DEBUG ("`swrite' failed. Closing socket #%i", sd);
742 sock_descr = sd = -1;
752 * req_code: Type of request packet
753 * req_items: Numver of items in the request
754 * req_size: Size of one item in the request
755 * req_data: Data of the request packet
756 * res_items: Pointer to where the number returned items will be stored.
757 * res_size: Pointer to where the size of one returned item will be stored.
758 * res_data: This is where a pointer to the (allocated) data will be stored.
759 * res_item_size: Size of one returned item. (used to calculate padding)
761 * returns: zero upon success, non-zero otherwise.
763 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
764 int *res_items, int *res_size, char **res_data, int res_item_size)
768 status = ntpd_send_request (req_code, req_items, req_size, req_data);
772 status = ntpd_receive_response (res_items, res_size, res_data,
777 static double ntpd_read_fp (int32_t val_int)
781 val_int = ntohl (val_int);
782 val_double = ((double) val_int) / FP_FRAC;
787 static uint32_t ntpd_get_refclock_id (struct info_peer_summary const *peer_info)
789 uint32_t addr = ntohl (peer_info->srcadr);
790 uint32_t refclock_id = (addr >> 8) & 0x00FF;
792 return (refclock_id);
795 static int ntpd_get_name_from_address (char *buffer, size_t buffer_size,
796 struct info_peer_summary const *peer_info, _Bool do_reverse_lookup)
798 struct sockaddr_storage sa = { 0 };
803 if (peer_info->v6_flag)
805 struct sockaddr_in6 sa6 = { 0 };
807 assert (sizeof (sa) >= sizeof (sa6));
809 sa6.sin6_family = AF_INET6;
810 sa6.sin6_port = htons (123);
811 memcpy (&sa6.sin6_addr, &peer_info->srcadr6,
812 sizeof (struct in6_addr));
813 sa_len = sizeof (sa6);
815 memcpy (&sa, &sa6, sizeof (sa6));
819 struct sockaddr_in sa4 = { 0 };
821 assert (sizeof (sa) >= sizeof (sa4));
823 sa4.sin_family = AF_INET;
824 sa4.sin_port = htons (123);
825 memcpy (&sa4.sin_addr, &peer_info->srcadr,
826 sizeof (struct in_addr));
827 sa_len = sizeof (sa4);
829 memcpy (&sa, &sa4, sizeof (sa4));
832 if (!do_reverse_lookup)
833 flags |= NI_NUMERICHOST;
835 status = getnameinfo ((struct sockaddr const *) &sa, sa_len,
837 NULL, 0, /* No port name */
842 ERROR ("ntpd plugin: getnameinfo failed: %s",
843 (status == EAI_SYSTEM)
844 ? sstrerror (errno, errbuf, sizeof (errbuf))
845 : gai_strerror (status));
850 } /* ntpd_get_name_from_address */
852 static int ntpd_get_name_refclock (char *buffer, size_t buffer_size,
853 struct info_peer_summary const *peer_info)
855 uint32_t refclock_id = ntpd_get_refclock_id (peer_info);
856 uint32_t unit_id = ntohl (peer_info->srcadr) & 0x00FF;
858 if (((size_t) refclock_id) >= refclock_names_num)
859 return (ntpd_get_name_from_address (buffer, buffer_size,
861 /* do_reverse_lookup = */ 0));
864 ssnprintf (buffer, buffer_size, "%s-%"PRIu32,
865 refclock_names[refclock_id], unit_id);
867 sstrncpy (buffer, refclock_names[refclock_id], buffer_size);
870 } /* int ntpd_get_name_refclock */
872 static int ntpd_get_name (char *buffer, size_t buffer_size,
873 struct info_peer_summary const *peer_info)
875 uint32_t addr = ntohl (peer_info->srcadr);
877 if (!peer_info->v6_flag && ((addr & REFCLOCK_MASK) == REFCLOCK_ADDR))
878 return (ntpd_get_name_refclock (buffer, buffer_size,
881 return (ntpd_get_name_from_address (buffer, buffer_size,
882 peer_info, do_reverse_lookups));
883 } /* int ntpd_addr_to_name */
885 static int ntpd_read (void)
887 struct info_kernel *ik;
891 struct info_peer_summary *ps;
897 gauge_t offset_error;
901 /* On Linux, if the STA_NANO bit is set in ik->status, then ik->offset
902 * is is nanoseconds, otherwise it's microseconds. */
903 double scale_loop = 1e-6;
904 double scale_error = 1e-6;
910 status = ntpd_do_query (REQ_GET_KERNEL,
911 0, 0, NULL, /* request data */
912 &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
913 sizeof (struct info_kernel));
916 ERROR ("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", status);
919 else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
921 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
922 "(ik = %p; ik_num = %i; ik_size = %i)",
923 (void *) ik, ik_num, ik_size);
927 if (ntohs(ik->status) & STA_NANO) {
932 /* kerninfo -> estimated error */
933 offset_loop = scale_loop * ((gauge_t) ntohl (ik->offset));
934 freq_loop = ntpd_read_fp (ik->freq);
935 offset_error = scale_error * ((gauge_t) ntohl (ik->esterror));
937 DEBUG ("info_kernel:\n"
938 " pll offset = %.8g\n"
939 " pll frequency = %.8g\n" /* drift compensation */
940 " est error = %.8g\n",
941 offset_loop, freq_loop, offset_error);
943 ntpd_submit ("frequency_offset", "loop", freq_loop);
944 ntpd_submit ("time_offset", "loop", offset_loop);
945 ntpd_submit ("time_offset", "error", offset_error);
950 status = ntpd_do_query (REQ_PEER_LIST_SUM,
951 0, 0, NULL, /* request data */
952 &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
953 sizeof (struct info_peer_summary));
956 ERROR ("ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", status);
959 else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
961 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
962 "(ps = %p; ps_num = %i; ps_size = %i)",
963 (void *) ps, ps_num, ps_size);
967 for (int i = 0; i < ps_num; i++)
969 struct info_peer_summary *ptr;
972 char peername[NI_MAXHOST];
973 uint32_t refclock_id;
977 status = ntpd_get_name (peername, sizeof (peername), ptr);
980 ERROR ("ntpd plugin: Determining name of peer failed.");
984 refclock_id = ntpd_get_refclock_id (ptr);
986 /* Convert the `long floating point' offset value to double */
987 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
997 " dispersion = %f\n",
1000 ntohl (ptr->srcadr),
1002 ntpd_read_fp (ptr->delay),
1003 ntohl (ptr->offset_int),
1004 ntohl (ptr->offset_frc),
1006 ntpd_read_fp (ptr->dispersion));
1008 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
1009 ntpd_submit_reach ("time_offset", peername, ptr->reach,
1011 ntpd_submit_reach ("time_dispersion", peername, ptr->reach,
1012 ntpd_read_fp (ptr->dispersion));
1013 if (refclock_id == 0) /* not a reference clock */
1014 ntpd_submit_reach ("delay", peername, ptr->reach,
1015 ntpd_read_fp (ptr->delay));
1022 } /* int ntpd_read */
1024 void module_register (void)
1026 plugin_register_config ("ntpd", ntpd_config,
1027 config_keys, config_keys_num);
1028 plugin_register_read ("ntpd", ntpd_read);
1029 } /* void module_register */