ntpd plugin: Converted to the new plugin interface.
[collectd.git] / src / ntpd.c
index a2b554e..366c24b 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * 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
@@ -25,8 +25,6 @@
 #include "configfile.h"
 #include "utils_debug.h"
 
-#define MODULE_NAME "ntpd"
-
 #if HAVE_SYS_SOCKET_H
 # define NTPD_HAVE_READ 1
 #else
 #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 int time_offset_ds_num = 1;
 
-static char *frequency_offset_file = "ntpd/frequency_offset-%s.rrd";
-static char *frequency_offset_ds_def[] =
+static data_set_t frequency_offset_ds =
 {
-       "DS:ppm:GAUGE:"COLLECTD_HEARTBEAT":0:100",
+       "frequency_offset", 1, ppm_dsrc
+};
+
+static const char *config_keys[] =
+{
+       "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"
@@ -75,7 +97,6 @@ static int frequency_offset_ds_num = 1;
 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  *
@@ -87,6 +108,9 @@ static char *ntpd_port = NULL;
 #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. */
 struct req_pkt
@@ -151,6 +175,54 @@ struct resp_pkt
 #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
 {
@@ -198,53 +270,68 @@ struct info_kernel
        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;
-}
-
-static void ntpd_write_time_offset (char *host, char *inst, char *val)
-{
-       char buf[256];
-       int  status;
-
-       status = snprintf (buf, 256, time_offset_file, inst);
-       if ((status < 1) || (status >= 256))
-               return;
-
-       rrd_update_file (host, buf, val,
-                       time_offset_ds_def, time_offset_ds_num);
-}
-
-static void ntpd_write_frequency_offset (char *host, char *inst, char *val)
-{
-       char buf[256];
-       int  status;
-
-       status = snprintf (buf, 256, frequency_offset_file, inst);
-       if ((status < 1) || (status >= 256))
-               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);
+       }
 
-       rrd_update_file (host, buf, val,
-                       frequency_offset_ds_def, frequency_offset_ds_num);
+       return (0);
 }
 
-#if NTPD_HAVE_READ
-static void ntpd_submit (char *type, char *inst, double value)
+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;
 
-       if (snprintf (buf, 256, "%u:%.8f", (unsigned int) curtime, value) >= 256)
-               return;
+       values[0].gauge = value;
 
-       DBG ("type = %s; inst = %s; value = %s;",
-                       type, inst, buf);
+       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 (type, inst, buf);
+       plugin_dispatch_values (type, &vl);
 }
 
 /* returns `tv0 - tv1' in milliseconds or 0 if `tv1 > tv0' */
@@ -437,6 +524,9 @@ static int ntpd_receive_response (int req_code, int *res_items, int *res_size,
                if (status < 0)
                {
                        DBG ("recv(2) failed: %s", strerror (errno));
+                       DBG ("Closing socket #%i", sd);
+                       close (sd);
+                       sock_descr = sd = -1;
                        return (-1);
                }
 
@@ -568,6 +658,7 @@ static int ntpd_receive_response (int req_code, int *res_items, int *res_size,
                                (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;
@@ -635,7 +726,12 @@ static int ntpd_send_request (int req_code, int req_items, int req_size, char *r
 
        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);
 }
@@ -678,12 +774,18 @@ static double ntpd_read_fp (int32_t val_int)
        return (val_double);
 }
 
-static void ntpd_read (void)
+static int ntpd_read (void)
 {
        struct info_kernel *ik;
        int                 ik_num;
        int                 ik_size;
-       int                 status;
+
+       struct info_peer_summary *ps;
+       int                       ps_num;
+       int                       ps_size;
+
+       int status;
+       int i;
 
        ik      = NULL;
        ik_num  = 0;
@@ -697,13 +799,13 @@ static void ntpd_read (void)
        if (status != 0)
        {
                DBG ("ntpd_do_query failed with status %i", status);
-               return;
+               return (-1);
        }
        if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
        {
-               DBG ("ntpd_do_query returned: is = %p; ik_num = %i; ik_size = %i;",
+               DBG ("ntpd_do_query returned: ik = %p; ik_num = %i; ik_size = %i;",
                                (void *) ik, ik_num, ik_size);
-               return;
+               return (-1);
        }
 
        /* kerninfo -> estimated error */
@@ -716,22 +818,153 @@ static void ntpd_read (void)
                        ntpd_read_fp (ik->freq),
                        ntpd_read_fp (ik->esterror));
 
-       ntpd_submit ("ntpd_frequency_offset", "loop", ntpd_read_fp (ik->freq));
+       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;
 
-       return;
-}
-#else
-# define ntpd_read 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, NULL);
-       plugin_register ("ntpd_time_offset", NULL, NULL, ntpd_write_time_offset);
-       plugin_register ("ntpd_frequency_offset", NULL, NULL, ntpd_write_frequency_offset);
-}
+       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 */
+}