2 * collectd - src/ntpd.c
3 * Copyright (C) 2006 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
26 #include "utils_debug.h"
28 #define MODULE_NAME "ntpd"
31 # define NTPD_HAVE_READ 1
33 # define NTPD_HAVE_READ 0
43 # include <sys/socket.h>
46 # include <netinet/in.h>
49 # include <arpa/inet.h> /* inet_ntoa */
51 #if HAVE_NETINET_TCP_H
52 # include <netinet/tcp.h>
55 # include <sys/poll.h>
59 static char *time_offset_file = "ntpd/time_offset-%s.rrd";
60 static char *time_offset_ds_def[] =
62 "DS:ms:GAUGE:"COLLECTD_HEARTBEAT":-1000000:1000000",
65 static int time_offset_ds_num = 1;
67 static char *frequency_offset_file = "ntpd/frequency_offset-%s.rrd";
68 static char *frequency_offset_ds_def[] =
70 "DS:ppm:GAUGE:"COLLECTD_HEARTBEAT":-1000000:1000000",
73 static int frequency_offset_ds_num = 1;
76 # define NTPD_DEFAULT_HOST "localhost"
77 # define NTPD_DEFAULT_PORT "123"
78 static int sock_descr = -1;
79 static char *ntpd_host = NULL;
80 static char *ntpd_port = NULL;
83 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
84 * The following definitions were copied from the NTPd distribution *
85 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
86 #define MAXFILENAME 128
88 #define MODE_PRIVATE 7
89 #define NTP_OLDVERSION ((u_char) 1) /* oldest credible version */
91 #define FP_FRAC 65536.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) ((u_char)(((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 ((u_char)(((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) ((u_char)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
148 #define INFO_ERR(err_nitems) ((u_short)((ntohs(err_nitems)>>12)&0xf))
149 #define INFO_NITEMS(err_nitems) ((u_short)(ntohs(err_nitems)&0xfff))
150 #define ERR_NITEMS(err, nitems) (htons((u_short)((((u_short)(err)<<12)&0xf000)\
151 |((u_short)(nitems)&0xfff))))
153 #define INFO_MBZ(mbz_itemsize) ((ntohs(mbz_itemsize)>>12)&0xf)
154 #define INFO_ITEMSIZE(mbz_itemsize) ((u_short)(ntohs(mbz_itemsize)&0xfff))
155 #define MBZ_ITEMSIZE(itemsize) (htons((u_short)(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 i; \
171 register uint32_t f; \
177 (d) = -((double) i + ((double) f) / 4294967296.0); \
179 (d) = (double) i + ((double) f) / 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
252 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
253 * End of the copied stuff.. *
254 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
256 static void ntpd_init (void)
261 static void ntpd_write_time_offset (char *host, char *inst, char *val)
266 status = snprintf (buf, 256, time_offset_file, inst);
267 if ((status < 1) || (status >= 256))
270 rrd_update_file (host, buf, val,
271 time_offset_ds_def, time_offset_ds_num);
274 static void ntpd_write_frequency_offset (char *host, char *inst, char *val)
279 status = snprintf (buf, 256, frequency_offset_file, inst);
280 if ((status < 1) || (status >= 256))
283 rrd_update_file (host, buf, val,
284 frequency_offset_ds_def, frequency_offset_ds_num);
288 static void ntpd_submit (char *type, char *inst, double value)
292 if (snprintf (buf, 256, "%u:%.8f", (unsigned int) curtime, value) >= 256)
295 DBG ("type = %s; inst = %s; value = %s;",
298 plugin_submit (type, inst, buf);
301 /* returns `tv0 - tv1' in milliseconds or 0 if `tv1 > tv0' */
302 static int timeval_sub (const struct timeval *tv0, const struct timeval *tv1)
307 if ((tv0->tv_sec < tv1->tv_sec)
308 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
311 sec = tv0->tv_sec - tv1->tv_sec;
312 usec = tv0->tv_usec - tv1->tv_usec;
323 return ((sec * 1000) + ((usec + 500) / 1000));
326 static int ntpd_connect (void)
331 struct addrinfo ai_hints;
332 struct addrinfo *ai_list;
333 struct addrinfo *ai_ptr;
339 DBG ("Opening a new socket");
343 host = NTPD_DEFAULT_HOST;
347 port = NTPD_DEFAULT_PORT;
349 memset (&ai_hints, '\0', sizeof (ai_hints));
350 ai_hints.ai_flags = AI_ADDRCONFIG;
351 ai_hints.ai_family = PF_UNSPEC;
352 ai_hints.ai_socktype = SOCK_DGRAM;
353 ai_hints.ai_protocol = IPPROTO_UDP;
355 if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
357 DBG ("getaddrinfo (%s, %s): %s",
359 status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
360 syslog (LOG_ERR, "ntpd plugin: getaddrinfo (%s, %s): %s",
362 status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
366 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
368 /* create our socket descriptor */
369 if ((sock_descr = socket (ai_ptr->ai_family,
371 ai_ptr->ai_protocol)) < 0)
374 /* connect to the ntpd */
375 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
385 freeaddrinfo (ai_list);
389 DBG ("Unable to connect to server.");
390 syslog (LOG_ERR, "ntpd plugin: Unable to connect to server.");
396 /* For a description of the arguments see `ntpd_do_query' below. */
397 static int ntpd_receive_response (int req_code, int *res_items, int *res_size,
398 char **res_data, int res_item_size)
401 struct pollfd poll_s;
410 struct timeval time_end;
411 struct timeval time_now;
414 int pkt_item_num; /* items in this packet */
415 int pkt_item_len; /* size of the items in this packet */
417 char pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
418 int pkt_recvd_num; /* number of packets that have been received */
419 int pkt_lastseq; /* the last sequence number */
420 ssize_t pkt_padding; /* Padding in this packet */
422 if ((sd = ntpd_connect ()) < 0)
428 memset (pkt_recvd, '\0', sizeof (pkt_recvd));
436 if (gettimeofday (&time_end, NULL) < 0)
438 syslog (LOG_ERR, "ntpd plugin: gettimeofday failed: %s",
442 time_end.tv_sec++; /* wait for a most one second */
447 if (gettimeofday (&time_now, NULL) < 0)
449 syslog (LOG_ERR, "ntpd plugin: gettimeofday failed: %s",
454 /* timeout reached */
455 if ((timeout = timeval_sub (&time_end, &time_now)) == 0)
459 poll_s.events = POLLIN | POLLPRI;
462 DBG ("Polling for %ims", timeout);
463 status = poll (&poll_s, 1, timeout);
465 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
470 DBG ("poll failed: %s", strerror (errno));
471 syslog (LOG_ERR, "ntpd plugin: poll failed: %s",
476 if (status == 0) /* timeout */
478 DBG ("timeout reached.");
482 memset ((void *) &res, '\0', sizeof (res));
483 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
485 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
490 DBG ("recv(2) failed: %s", strerror (errno));
494 DBG ("recv'd %i bytes", status);
497 * Do some sanity checks first
499 if (status < RESP_HEADER_SIZE)
501 syslog (LOG_WARNING, "ntpd plugin: Short (%i bytes) packet received",
505 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
507 syslog (LOG_NOTICE, "ntpd plugin: Packet received with mode %i",
508 INFO_MODE (res.rm_vn_mode));
511 if (INFO_IS_AUTH (res.auth_seq))
513 syslog (LOG_NOTICE, "ntpd plugin: Encrypted packet received");
516 if (!ISRESPONSE (res.rm_vn_mode))
518 syslog (LOG_NOTICE, "ntpd plugin: Received request packet, "
522 if (INFO_MBZ (res.mbz_itemsize))
524 syslog (LOG_WARNING, "ntpd plugin: Received packet with nonzero "
528 if (res.implementation != IMPL_XNTPD)
530 syslog (LOG_WARNING, "ntpd plugin: Asked for request of type %i, "
531 "got %i", (int) IMPL_XNTPD, (int) res.implementation);
535 /* Check for error code */
536 if (INFO_ERR (res.err_nitems) != 0)
538 syslog (LOG_ERR, "ntpd plugin: Received error code %i",
539 (int) INFO_ERR(res.err_nitems));
540 return ((int) INFO_ERR (res.err_nitems));
543 /* extract number of items in this packet and the size of these items */
544 pkt_item_num = INFO_NITEMS (res.err_nitems);
545 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
546 DBG ("pkt_item_num = %i; pkt_item_len = %i;",
547 pkt_item_num, pkt_item_len);
549 /* Check if the reported items fit in the packet */
550 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
552 syslog (LOG_ERR, "ntpd plugin: %i items * %i bytes > "
553 "%i bytes - %i bytes header",
554 (int) pkt_item_num, (int) pkt_item_len,
555 (int) status, (int) RESP_HEADER_SIZE);
559 /* If this is the first packet (time wise, not sequence wise),
560 * set `res_size'. If it's not the first packet check if the
561 * items have the same size. Discard invalid packets. */
562 if (items_num == 0) /* first packet */
564 DBG ("*res_size = %i", pkt_item_len);
565 *res_size = pkt_item_len;
567 else if (*res_size != pkt_item_len)
569 DBG ("Error: *res_size = %i; pkt_item_len = %i;",
570 *res_size, pkt_item_len);
571 syslog (LOG_ERR, "Item sizes differ.");
575 /* Calculate the padding. No idea why there might be any padding.. */
577 if (res_item_size > pkt_item_len)
578 pkt_padding = res_item_size - pkt_item_len;
579 DBG ("res_item_size = %i; pkt_padding = %i;",
580 res_item_size, pkt_padding);
582 /* Extract the sequence number */
583 pkt_sequence = INFO_SEQ (res.auth_seq);
584 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
586 syslog (LOG_ERR, "ntpd plugin: Received packet with sequence %i",
591 /* Check if this sequence has been received before. If so, discard it. */
592 if (pkt_recvd[pkt_sequence] != '\0')
594 syslog (LOG_NOTICE, "ntpd plugin: Sequence %i received twice",
599 /* If `pkt_lastseq != -1' another packet without `more bit' has
601 if (!ISMORE (res.rm_vn_mode))
603 if (pkt_lastseq != -1)
605 syslog (LOG_ERR, "ntpd plugin: Two packets which both "
606 "claim to be the last one in the "
607 "sequence have been received.");
610 pkt_lastseq = pkt_sequence;
611 DBG ("Last sequence = %i;", pkt_lastseq);
615 * Enough with the checks. Copy the data now.
616 * We start by allocating some more memory.
618 DBG ("realloc (%p, %i)", (void *) *res_data,
619 (items_num + pkt_item_num) * res_item_size);
620 items = realloc ((void *) *res_data,
621 (items_num + pkt_item_num) * res_item_size);
625 syslog (LOG_ERR, "ntpd plugin: realloc failed.");
630 for (i = 0; i < pkt_item_num; i++)
632 void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
633 void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
635 /* Set the padding to zeros */
636 if (pkt_padding != 0)
637 memset (dst, '\0', res_item_size);
638 memcpy (dst, src, (size_t) pkt_item_len);
643 pkt_recvd[pkt_sequence] = (char) 1;
646 if ((pkt_recvd_num - 1) == pkt_lastseq)
648 } /* while (done == 0) */
653 /* For a description of the arguments see `ntpd_do_query' below. */
654 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
661 assert (req_items >= 0);
662 assert (req_size >= 0);
664 if ((sd = ntpd_connect ()) < 0)
667 memset ((void *) &req, '\0', sizeof (req));
668 req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
669 req.auth_seq = AUTH_SEQ (0, 0);
670 req.implementation = IMPL_XNTPD;
671 req.request = (unsigned char) req_code;
673 req_data_len = (size_t) (req_items * req_size);
675 assert (((req_data != NULL) && (req_data_len > 0))
676 || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
678 req.err_nitems = ERR_NITEMS (0, req_items);
679 req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
681 if (req_data != NULL)
682 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
684 DBG ("req_items = %i; req_size = %i; req_data = %p;",
685 req_items, req_size, (void *) req_data);
687 status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
697 * req_code: Type of request packet
698 * req_items: Numver of items in the request
699 * req_size: Size of one item in the request
700 * req_data: Data of the request packet
701 * res_items: Pointer to where the number returned items will be stored.
702 * res_size: Pointer to where the size of one returned item will be stored.
703 * res_data: This is where a pointer to the (allocated) data will be stored.
704 * res_item_size: Size of one returned item. (used to calculate padding)
706 * returns: zero upon success, non-zero otherwise.
708 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
709 int *res_items, int *res_size, char **res_data, int res_item_size)
713 status = ntpd_send_request (req_code, req_items, req_size, req_data);
717 status = ntpd_receive_response (req_code, res_items, res_size, res_data,
722 static double ntpd_read_fp (int32_t val_int)
726 val_int = ntohl (val_int);
727 val_double = ((double) val_int) / FP_FRAC;
732 static void ntpd_read (void)
734 struct info_kernel *ik;
738 struct info_peer_summary *ps;
749 status = ntpd_do_query (REQ_GET_KERNEL,
750 0, 0, NULL, /* request data */
751 &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
752 sizeof (struct info_kernel));
756 DBG ("ntpd_do_query failed with status %i", status);
759 if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
761 DBG ("ntpd_do_query returned: ik = %p; ik_num = %i; ik_size = %i;",
762 (void *) ik, ik_num, ik_size);
766 /* kerninfo -> estimated error */
768 DBG ("info_kernel:\n"
769 " pll offset = %.8f\n"
770 " pll frequency = %.8f\n" /* drift compensation */
771 " est error = %.8f\n",
772 ntpd_read_fp (ik->offset),
773 ntpd_read_fp (ik->freq),
774 ntpd_read_fp (ik->esterror));
776 ntpd_submit ("ntpd_frequency_offset", "loop", ntpd_read_fp (ik->freq));
777 ntpd_submit ("ntpd_time_offset", "loop", ntpd_read_fp (ik->offset));
778 ntpd_submit ("ntpd_time_offset", "error", ntpd_read_fp (ik->esterror));
783 status = ntpd_do_query (REQ_PEER_LIST_SUM,
784 0, 0, NULL, /* request data */
785 &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
786 sizeof (struct info_peer_summary));
789 DBG ("ntpd_do_query failed with status %i", status);
792 if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
794 DBG ("ntpd_do_query returned: ps = %p; ps_num = %i; ps_size = %i;",
795 (void *) ps, ps_num, ps_size);
799 for (i = 0; i < ps_num; i++)
801 struct info_peer_summary *ptr;
808 if (((ntohl (ptr->dstadr) & 0xFF000000) == 0x7F000000) || (ptr->dstadr == 0))
811 /* Convert the `long floating point' offset value to double */
812 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
816 status = getnameinfo ((const struct sockaddr *) &ptr->srcadr6,
817 sizeof (ptr->srcadr6),
818 peername, sizeof (peername),
819 NULL, 0, 0 /* no flags */);
822 syslog (LOG_ERR, "ntpd plugin: getnameinfo failed: %s",
825 : gai_strerror (status));
831 struct in_addr addr_obj;
832 struct hostent *addr_he;
835 memset ((void *) &addr_obj, '\0', sizeof (addr_obj));
836 addr_obj.s_addr = ptr->srcadr;
837 addr_str = inet_ntoa (addr_obj);
839 addr_he = gethostbyaddr ((const void *) &addr_obj,
840 sizeof (addr_obj), AF_INET);
843 strncpy (peername, addr_he->h_name, sizeof (peername));
847 strncpy (peername, addr_str, sizeof (peername));
858 " dispersion = %f\n",
862 ntpd_read_fp (ptr->delay),
863 ntohl (ptr->offset_int),
864 ntohl (ptr->offset_frc),
866 ntpd_read_fp (ptr->dispersion));
868 ntpd_submit ("ntpd_time_offset", peername, offset);
877 # define ntpd_read NULL
878 #endif /* NTPD_HAVE_READ */
880 void module_register (void)
882 plugin_register (MODULE_NAME, ntpd_init, ntpd_read, NULL);
883 plugin_register ("ntpd_time_offset", NULL, NULL, ntpd_write_time_offset);
884 plugin_register ("ntpd_frequency_offset", NULL, NULL, ntpd_write_frequency_offset);