/**
* collectd - src/ntpd.c
- * Copyright (C) 2006 Florian octo Forster
+ * Copyright (C) 2006-2007 Florian octo Forster
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
#include "common.h"
#include "plugin.h"
#include "configfile.h"
-
-#define MODULE_NAME "ntpd"
+#include "utils_debug.h"
#if HAVE_SYS_SOCKET_H
# define NTPD_HAVE_READ 1
#if HAVE_NETINET_IN_H
# include <netinet/in.h>
#endif
+#if HAVE_ARPA_INET_H
+# include <arpa/inet.h> /* inet_ntoa */
+#endif
#if HAVE_NETINET_TCP_H
# include <netinet/tcp.h>
#endif
-#if HAVE_SYS_POLL_H
-# include <sys/poll.h>
+#if HAVE_POLL_H
+# include <poll.h>
#endif
-/* drift */
-static char *time_offset_file = "ntpd/time_offset-%s.rrd";
-static char *time_offset_ds_def[] =
+static data_source_t seconds_dsrc[1] =
{
- "DS:ms:GAUGE:"COLLECTD_HEARTBEAT":0:100",
- NULL
+ {"seconds", DS_TYPE_GAUGE, -1000000.0, 1000000.0}
+};
+
+static data_set_t time_offset_ds =
+{
+ "time_offset", 1, seconds_dsrc
+};
+
+static data_set_t time_dispersion_ds =
+{
+ "time_dispersion", 1, seconds_dsrc
+};
+
+static data_set_t delay_ds =
+{
+ "delay", 1, seconds_dsrc
+};
+
+static data_source_t ppm_dsrc[1] =
+{
+ {"ppm", DS_TYPE_GAUGE, -1000000.0, 1000000.0}
+};
+
+static data_set_t frequency_offset_ds =
+{
+ "frequency_offset", 1, ppm_dsrc
};
-static int time_offset_ds_num = 1;
-static char *frequency_offset_file = "ntpd/frequency_offset-%s.rrd";
-static char *frequency_offset_ds_def[] =
+static const char *config_keys[] =
{
- "DS:ppm:GAUGE:"COLLECTD_HEARTBEAT":0:100",
+ "Host",
+ "Port",
NULL
};
-static int frequency_offset_ds_num = 1;
+static int config_keys_num = 2;
#if NTPD_HAVE_READ
# define NTPD_DEFAULT_HOST "localhost"
static int sock_descr = -1;
static char *ntpd_host = NULL;
static char *ntpd_port = NULL;
-#endif
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* The following definitions were copied from the NTPd distribution *
#define MODE_PRIVATE 7
#define NTP_OLDVERSION ((u_char) 1) /* oldest credible version */
#define IMPL_XNTPD 3
+#define FP_FRAC 65536.0
+
+#define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */
+#define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */
/* This structure is missing the message authentication code, since collectd
* doesn't use it. */
#define INFO_MBZ(mbz_itemsize) ((ntohs(mbz_itemsize)>>12)&0xf)
#define INFO_ITEMSIZE(mbz_itemsize) ((u_short)(ntohs(mbz_itemsize)&0xfff))
#define MBZ_ITEMSIZE(itemsize) (htons((u_short)(itemsize)))
+
+/* negate a long float type */
+#define M_NEG(v_i, v_f) \
+ do { \
+ if ((v_f) == 0) \
+ (v_i) = -((uint32_t)(v_i)); \
+ else { \
+ (v_f) = -((uint32_t)(v_f)); \
+ (v_i) = ~(v_i); \
+ } \
+ } while(0)
+/* l_fp to double */
+#define M_LFPTOD(r_i, r_uf, d) \
+ do { \
+ register int32_t i; \
+ register uint32_t f; \
+ \
+ i = (r_i); \
+ f = (r_uf); \
+ if (i < 0) { \
+ M_NEG(i, f); \
+ (d) = -((double) i + ((double) f) / 4294967296.0); \
+ } else { \
+ (d) = (double) i + ((double) f) / 4294967296.0; \
+ } \
+ } while (0)
+
+#define REQ_PEER_LIST_SUM 1
+struct info_peer_summary
+{
+ uint32_t dstadr; /* local address (zero for undetermined) */
+ uint32_t srcadr; /* source address */
+ uint16_t srcport; /* source port */
+ uint8_t stratum; /* stratum of peer */
+ int8_t hpoll; /* host polling interval */
+ int8_t ppoll; /* peer polling interval */
+ uint8_t reach; /* reachability register */
+ uint8_t flags; /* flags, from above */
+ uint8_t hmode; /* peer mode */
+ int32_t delay; /* peer.estdelay; s_fp */
+ int32_t offset_int; /* peer.estoffset; integral part */
+ int32_t offset_frc; /* peer.estoffset; fractional part */
+ uint32_t dispersion; /* peer.estdisp; u_fp */
+ uint32_t v6_flag; /* is this v6 or not */
+ uint32_t unused1; /* (unused) padding for dstadr6 */
+ struct in6_addr dstadr6; /* local address (v6) */
+ struct in6_addr srcadr6; /* source address (v6) */
+};
+
+#define REQ_SYS_INFO 4
+struct info_sys
+{
+ uint32_t peer; /* system peer address (v4) */
+ uint8_t peer_mode; /* mode we are syncing to peer in */
+ uint8_t leap; /* system leap bits */
+ uint8_t stratum; /* our stratum */
+ int8_t precision; /* local clock precision */
+ int32_t rootdelay; /* distance from sync source */
+ uint32_t rootdispersion; /* dispersion from sync source */
+ uint32_t refid; /* reference ID of sync source */
+ uint64_t reftime; /* system reference time */
+ uint32_t poll; /* system poll interval */
+ uint8_t flags; /* system flags */
+ uint8_t unused1; /* unused */
+ uint8_t unused2; /* unused */
+ uint8_t unused3; /* unused */
+ int32_t bdelay; /* default broadcast offset */
+ int32_t frequency; /* frequency residual (scaled ppm) */
+ uint64_t authdelay; /* default authentication delay */
+ uint32_t stability; /* clock stability (scaled ppm) */
+ int32_t v6_flag; /* is this v6 or not */
+ int32_t unused4; /* unused, padding for peer6 */
+ struct in6_addr peer6; /* system peer address (v6) */
+};
+
+#define REQ_GET_KERNEL 38
+struct info_kernel
+{
+ int32_t offset;
+ int32_t freq;
+ int32_t maxerror;
+ int32_t esterror;
+ uint16_t status;
+ uint16_t shift;
+ int32_t constant;
+ int32_t precision;
+ int32_t tolerance;
+ /* pps stuff */
+ int32_t ppsfreq;
+ int32_t jitter;
+ int32_t stabil;
+ int32_t jitcnt;
+ int32_t calcnt;
+ int32_t errcnt;
+ int32_t stbcnt;
+};
+
+/* List of reference clock names */
+static char *refclock_names[] =
+{
+ "UNKNOWN", "LOCAL", "GPS_TRAK", "WWV_PST", /* 0- 3 */
+ "SPECTRACOM", "TRUETIME", "IRIG_AUDIO", "CHU_AUDIO", /* 4- 7 */
+ "GENERIC", "GPS_MX4200", "GPS_AS2201", "GPS_ARBITER", /* 8-11 */
+ "IRIG_TPRO", "ATOM_LEITCH", "MSF_EES", "GPSTM_TRUE", /* 12-15 */
+ "GPS_BANC", "GPS_DATUM", "ACTS_NIST", "WWV_HEATH", /* 16-19 */
+ "GPS_NMEA", "GPS_VME", "PPS", "ACTS_PTB", /* 20-23 */
+ "ACTS_USNO", "TRUETIME", "GPS_HP", "MSF_ARCRON", /* 24-27 */
+ "SHM", "GPS_PALISADE", "GPS_ONCORE", "GPS_JUPITER", /* 28-31 */
+ "CHRONOLOG", "DUMBCLOCK", "ULINK_M320", "PCF", /* 32-35 */
+ "WWV_AUDIO", "GPS_FG", "HOPF_S", "HOPF_P", /* 36-39 */
+ "JJY", "TT_IRIG", "GPS_ZYFER", "GPS_RIPENCC", /* 40-43 */
+ "NEOCLK4X", NULL /* 44 */
+};
+static int refclock_names_num = 45;
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* End of the copied stuff.. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-static void ntpd_init (void)
+static int ntpd_config (const char *key, const char *value)
{
- return;
-}
+ if (strcasecmp (key, "host") == 0)
+ {
+ if (ntpd_host != NULL)
+ free (ntpd_host);
+ if ((ntpd_host = strdup (value)) == NULL)
+ return (1);
+ }
+ else if (strcasecmp (key, "port") == 0)
+ {
+ if (ntpd_port != NULL)
+ free (ntpd_port);
+ if ((ntpd_port = strdup (value)) == NULL)
+ return (1);
+ }
+ else
+ {
+ return (-1);
+ }
-static void ntpd_write (char *host, char *inst, char *val)
-{
- rrd_update_file (host, time_offset_file, val,
- time_offset_ds_def, time_offset_ds_num); /* FIXME filename incorrect */
+ return (0);
}
-#if NTPD_HAVE_READ
-static void ntpd_submit (double snum, double mnum, double lnum)
+static void ntpd_submit (char *type, char *type_inst, double value)
{
- char buf[256];
+ value_t values[1];
+ value_list_t vl = VALUE_LIST_INIT;
+
+ values[0].gauge = value;
- if (snprintf (buf, 256, "%u:%.2f:%.2f:%.2f", (unsigned int) curtime,
- snum, mnum, lnum) >= 256)
- return;
+ vl.values = values;
+ vl.values_len = 1;
+ vl.time = time (NULL);
+ strcpy (vl.host, hostname);
+ strcpy (vl.plugin, "ntpd");
+ strcpy (vl.plugin_instance, "");
+ strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
- plugin_submit (MODULE_NAME, "-", buf);
+ plugin_dispatch_values (type, &vl);
}
/* returns `tv0 - tv1' in milliseconds or 0 if `tv1 > tv0' */
if (sock_descr >= 0)
return (sock_descr);
+ DBG ("Opening a new socket");
+
host = ntpd_host;
if (host == NULL)
host = NTPD_DEFAULT_HOST;
if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
{
+ DBG ("getaddrinfo (%s, %s): %s",
+ host, port,
+ status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
syslog (LOG_ERR, "ntpd plugin: getaddrinfo (%s, %s): %s",
host, port,
status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
freeaddrinfo (ai_list);
if (sock_descr < 0)
+ {
+ DBG ("Unable to connect to server.");
syslog (LOG_ERR, "ntpd plugin: Unable to connect to server.");
+ }
return (sock_descr);
}
poll_s.events = POLLIN | POLLPRI;
poll_s.revents = 0;
+ DBG ("Polling for %ims", timeout);
status = poll (&poll_s, 1, timeout);
if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
if (status < 0)
{
+ DBG ("poll failed: %s", strerror (errno));
syslog (LOG_ERR, "ntpd plugin: poll failed: %s",
strerror (errno));
return (-1);
}
if (status == 0) /* timeout */
+ {
+ DBG ("timeout reached.");
break;
+ }
memset ((void *) &res, '\0', sizeof (res));
status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
continue;
if (status < 0)
+ {
+ DBG ("recv(2) failed: %s", strerror (errno));
+ DBG ("Closing socket #%i", sd);
+ close (sd);
+ sock_descr = sd = -1;
return (-1);
+ }
+
+ DBG ("recv'd %i bytes", status);
/*
* Do some sanity checks first
"MBZ field!");
continue;
}
- if (res.implementation != req_code)
+ if (res.implementation != IMPL_XNTPD)
{
syslog (LOG_WARNING, "ntpd plugin: Asked for request of type %i, "
- "got %i", (int) req_code, (int) res.implementation);
+ "got %i", (int) IMPL_XNTPD, (int) res.implementation);
continue;
}
/* extract number of items in this packet and the size of these items */
pkt_item_num = INFO_NITEMS (res.err_nitems);
pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
+ DBG ("pkt_item_num = %i; pkt_item_len = %i;",
+ pkt_item_num, pkt_item_len);
/* Check if the reported items fit in the packet */
if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
* items have the same size. Discard invalid packets. */
if (items_num == 0) /* first packet */
{
+ DBG ("*res_size = %i", pkt_item_len);
*res_size = pkt_item_len;
}
else if (*res_size != pkt_item_len)
{
+ DBG ("Error: *res_size = %i; pkt_item_len = %i;",
+ *res_size, pkt_item_len);
syslog (LOG_ERR, "Item sizes differ.");
continue;
}
pkt_padding = 0;
if (res_item_size > pkt_item_len)
pkt_padding = res_item_size - pkt_item_len;
+ DBG ("res_item_size = %i; pkt_padding = %i;",
+ res_item_size, pkt_padding);
/* Extract the sequence number */
pkt_sequence = INFO_SEQ (res.auth_seq);
continue;
}
pkt_lastseq = pkt_sequence;
+ DBG ("Last sequence = %i;", pkt_lastseq);
}
/*
* Enough with the checks. Copy the data now.
* We start by allocating some more memory.
*/
+ DBG ("realloc (%p, %i)", (void *) *res_data,
+ (items_num + pkt_item_num) * res_item_size);
items = realloc ((void *) *res_data,
(items_num + pkt_item_num) * res_item_size);
+ items_num += pkt_item_num;
if (items == NULL)
{
items = *res_data;
if (req_data != NULL)
memcpy ((void *) req.data, (const void *) req_data, req_data_len);
+ DBG ("req_items = %i; req_size = %i; req_data = %p;",
+ req_items, req_size, (void *) req_data);
+
status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
if (status < 0)
+ {
+ DBG ("`swrite' failed. Closing socket #%i", sd);
+ close (sd);
+ sock_descr = sd = -1;
return (status);
+ }
return (0);
}
return (status);
}
-static void ntpd_read (void)
+static double ntpd_read_fp (int32_t val_int)
{
- return;
+ double val_double;
+
+ val_int = ntohl (val_int);
+ val_double = ((double) val_int) / FP_FRAC;
+
+ return (val_double);
}
-#else
-# define ntpd_read NULL
+
+static int ntpd_read (void)
+{
+ struct info_kernel *ik;
+ int ik_num;
+ int ik_size;
+
+ struct info_peer_summary *ps;
+ int ps_num;
+ int ps_size;
+
+ int status;
+ int i;
+
+ ik = NULL;
+ ik_num = 0;
+ ik_size = 0;
+
+ status = ntpd_do_query (REQ_GET_KERNEL,
+ 0, 0, NULL, /* request data */
+ &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
+ sizeof (struct info_kernel));
+
+ if (status != 0)
+ {
+ DBG ("ntpd_do_query failed with status %i", status);
+ return (-1);
+ }
+ if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
+ {
+ DBG ("ntpd_do_query returned: ik = %p; ik_num = %i; ik_size = %i;",
+ (void *) ik, ik_num, ik_size);
+ return (-1);
+ }
+
+ /* kerninfo -> estimated error */
+
+ DBG ("info_kernel:\n"
+ " pll offset = %.8f\n"
+ " pll frequency = %.8f\n" /* drift compensation */
+ " est error = %.8f\n",
+ ntpd_read_fp (ik->offset),
+ ntpd_read_fp (ik->freq),
+ ntpd_read_fp (ik->esterror));
+
+ ntpd_submit ("frequency_offset", "loop", ntpd_read_fp (ik->freq));
+ ntpd_submit ("time_offset", "loop", ntpd_read_fp (ik->offset));
+ ntpd_submit ("time_offset", "error", ntpd_read_fp (ik->esterror));
+
+ free (ik);
+ ik = NULL;
+
+ status = ntpd_do_query (REQ_PEER_LIST_SUM,
+ 0, 0, NULL, /* request data */
+ &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
+ sizeof (struct info_peer_summary));
+ if (status != 0)
+ {
+ DBG ("ntpd_do_query failed with status %i", status);
+ return (-1);
+ }
+ if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
+ {
+ DBG ("ntpd_do_query returned: ps = %p; ps_num = %i; ps_size = %i;",
+ (void *) ps, ps_num, ps_size);
+ return (-1);
+ }
+
+ for (i = 0; i < ps_num; i++)
+ {
+ struct info_peer_summary *ptr;
+ double offset;
+
+ char peername[NI_MAXHOST];
+ int refclock_id;
+
+ ptr = ps + i;
+ refclock_id = 0;
+
+ /*
+ if (((ntohl (ptr->dstadr) & 0xFFFFFF00) == 0x7F000000) || (ptr->dstadr == 0))
+ continue;
+ */
+
+ /* Convert the `long floating point' offset value to double */
+ M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
+
+ if (ptr->v6_flag)
+ {
+ struct sockaddr_in6 sa;
+
+ memset (&sa, 0, sizeof (sa));
+ sa.sin6_family = AF_INET6;
+ sa.sin6_port = htons (123);
+ memcpy (&sa.sin6_addr, &ptr->srcadr6, sizeof (struct in6_addr));
+
+ status = getnameinfo ((const struct sockaddr *) &sa,
+ sizeof (sa),
+ peername, sizeof (peername),
+ NULL, 0, 0 /* no flags */);
+ if (status != 0)
+ {
+ syslog (LOG_ERR, "ntpd plugin: getnameinfo failed: %s",
+ status == EAI_SYSTEM
+ ? strerror (errno)
+ : gai_strerror (status));
+ continue;
+ }
+ }
+ else if ((ntohl (ptr->srcadr) & REFCLOCK_MASK) == REFCLOCK_ADDR)
+ {
+ struct in_addr addr_obj;
+ char *addr_str;
+
+ refclock_id = (ntohl (ptr->srcadr) >> 8) & 0x000000FF;
+
+ if (refclock_id < refclock_names_num)
+ {
+ strncpy (peername, refclock_names[refclock_id],
+ sizeof (peername));
+ }
+ else
+ {
+ memset ((void *) &addr_obj, '\0', sizeof (addr_obj));
+ addr_obj.s_addr = ptr->srcadr;
+ addr_str = inet_ntoa (addr_obj);
+
+ strncpy (peername, addr_str, sizeof (peername));
+ }
+ }
+ else /* IPv4 */
+ {
+ struct in_addr addr_obj;
+ struct hostent *addr_he;
+ char *addr_str;
+
+ memset ((void *) &addr_obj, '\0', sizeof (addr_obj));
+ addr_obj.s_addr = ptr->srcadr;
+ addr_str = inet_ntoa (addr_obj);
+
+ addr_he = gethostbyaddr ((const void *) &addr_obj,
+ sizeof (addr_obj), AF_INET);
+ if (addr_he != NULL)
+ {
+ strncpy (peername, addr_he->h_name, sizeof (peername));
+ }
+ else
+ {
+ strncpy (peername, addr_str, sizeof (peername));
+ }
+ }
+
+ DBG ("peer %i:\n"
+ " peername = %s\n"
+ " srcadr = 0x%08x\n"
+ " delay = %f\n"
+ " offset_int = %i\n"
+ " offset_frc = %i\n"
+ " offset = %f\n"
+ " dispersion = %f\n",
+ i,
+ peername,
+ ntohl (ptr->srcadr),
+ ntpd_read_fp (ptr->delay),
+ ntohl (ptr->offset_int),
+ ntohl (ptr->offset_frc),
+ offset,
+ ntpd_read_fp (ptr->dispersion));
+
+ if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
+ ntpd_submit ("time_offset", peername, offset);
+ ntpd_submit ("time_dispersion", peername, ntpd_read_fp (ptr->dispersion));
+ if (refclock_id == 0) /* not a reference clock */
+ ntpd_submit ("delay", peername, ntpd_read_fp (ptr->delay));
+ }
+
+ free (ps);
+ ps = NULL;
+
+ return (0);
+} /* int ntpd_read */
#endif /* NTPD_HAVE_READ */
void module_register (void)
{
- plugin_register (MODULE_NAME, ntpd_init, ntpd_read, ntpd_write);
-}
+ plugin_register_data_set (&time_offset_ds);
+ plugin_register_data_set (&time_dispersion_ds);
+ plugin_register_data_set (&delay_ds);
+ plugin_register_data_set (&frequency_offset_ds);
-#undef MODULE_NAME
+#if NTPD_HAVE_READ
+ plugin_register_config ("ntpd", ntpd_config, config_keys, config_keys_num);
+ plugin_register_read ("ntpd", ntpd_read);
+#endif /* NTPD_HAVE_READ */
+}
projects / collectd.git / blobdiff