Code

ntpd branch: The ntpd-plugin compiles and gets _some_ values. Doesn't entirely work...
[collectd.git] / src / ntpd.c
1 /**
2  * collectd - src/ntpd.c
3  * Copyright (C) 2006  Florian octo Forster
4  *
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.
8  *
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.
13  *
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
17  *
18  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "configfile.h"
26 #include "utils_debug.h"
28 #define MODULE_NAME "ntpd"
30 #if HAVE_SYS_SOCKET_H
31 # define NTPD_HAVE_READ 1
32 #else
33 # define NTPD_HAVE_READ 0
34 #endif
36 #if HAVE_STDINT_H
37 # include <stdint.h>
38 #endif
39 #if HAVE_NETDB_H
40 # include <netdb.h>
41 #endif
42 #if HAVE_SYS_SOCKET_H
43 # include <sys/socket.h>
44 #endif
45 #if HAVE_NETINET_IN_H
46 # include <netinet/in.h>
47 #endif
48 #if HAVE_NETINET_TCP_H
49 # include <netinet/tcp.h>
50 #endif
51 #if HAVE_SYS_POLL_H
52 # include <sys/poll.h>
53 #endif
55 /* drift */
56 static char *time_offset_file = "ntpd/time_offset-%s.rrd";
57 static char *time_offset_ds_def[] =
58 {
59         "DS:ms:GAUGE:"COLLECTD_HEARTBEAT":0:100",
60         NULL
61 };
62 static int time_offset_ds_num = 1;
64 static char *frequency_offset_file = "ntpd/frequency_offset-%s.rrd";
65 static char *frequency_offset_ds_def[] =
66 {
67         "DS:ppm:GAUGE:"COLLECTD_HEARTBEAT":0:100",
68         NULL
69 };
70 static int frequency_offset_ds_num = 1;
72 #if NTPD_HAVE_READ
73 # define NTPD_DEFAULT_HOST "localhost"
74 # define NTPD_DEFAULT_PORT "123"
75 static int   sock_descr = -1;
76 static char *ntpd_host = NULL;
77 static char *ntpd_port = NULL;
78 #endif
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 ((u_char) 1) /* oldest credible version */
87 #define IMPL_XNTPD 3
88 #define FP_FRAC 65536.0
90 /* This structure is missing the message authentication code, since collectd
91  * doesn't use it. */
92 struct req_pkt
93 {
94         uint8_t  rm_vn_mode;
95         uint8_t  auth_seq;
96         uint8_t  implementation;                /* implementation number */
97         uint8_t  request;                       /* request number */
98         uint16_t err_nitems;            /* error code/number of data items */
99         uint16_t mbz_itemsize;          /* item size */
100         char     data[MAXFILENAME + 48];        /* data area [32 prev](176 byte max) */
101                                         /* struct conf_peer must fit */
102 };
103 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
105 /*
106  * A response packet.  The length here is variable, this is a
107  * maximally sized one.  Note that this implementation doesn't
108  * authenticate responses.
109  */
110 #define RESP_HEADER_SIZE        (8)
111 #define RESP_DATA_SIZE          (500)
113 struct resp_pkt
115         uint8_t  rm_vn_mode;           /* response, more, version, mode */
116         uint8_t  auth_seq;             /* key, sequence number */
117         uint8_t  implementation;       /* implementation number */
118         uint8_t  request;              /* request number */
119         uint16_t err_nitems;           /* error code/number of data items */
120         uint16_t mbz_itemsize;         /* item size */
121         char     data[RESP_DATA_SIZE]; /* data area */
122 };
124 /*
125  * Bit setting macros for multifield items.
126  */
127 #define RESP_BIT        0x80
128 #define MORE_BIT        0x40
130 #define ISRESPONSE(rm_vn_mode)  (((rm_vn_mode)&RESP_BIT)!=0)
131 #define ISMORE(rm_vn_mode)      (((rm_vn_mode)&MORE_BIT)!=0)
132 #define INFO_VERSION(rm_vn_mode) ((u_char)(((rm_vn_mode)>>3)&0x7))
133 #define INFO_MODE(rm_vn_mode)   ((rm_vn_mode)&0x7)
135 #define RM_VN_MODE(resp, more, version)         \
136                                 ((u_char)(((resp)?RESP_BIT:0)\
137                                 |((more)?MORE_BIT:0)\
138                                 |((version?version:(NTP_OLDVERSION+1))<<3)\
139                                 |(MODE_PRIVATE)))
141 #define INFO_IS_AUTH(auth_seq)  (((auth_seq) & 0x80) != 0)
142 #define INFO_SEQ(auth_seq)      ((auth_seq)&0x7f)
143 #define AUTH_SEQ(auth, seq)     ((u_char)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
145 #define INFO_ERR(err_nitems)    ((u_short)((ntohs(err_nitems)>>12)&0xf))
146 #define INFO_NITEMS(err_nitems) ((u_short)(ntohs(err_nitems)&0xfff))
147 #define ERR_NITEMS(err, nitems) (htons((u_short)((((u_short)(err)<<12)&0xf000)\
148                                 |((u_short)(nitems)&0xfff))))
150 #define INFO_MBZ(mbz_itemsize)  ((ntohs(mbz_itemsize)>>12)&0xf)
151 #define INFO_ITEMSIZE(mbz_itemsize)     ((u_short)(ntohs(mbz_itemsize)&0xfff))
152 #define MBZ_ITEMSIZE(itemsize)  (htons((u_short)(itemsize)))
154 #define REQ_SYS_INFO 4
155 struct info_sys
157         uint32_t peer;           /* system peer address (v4) */
158         uint8_t  peer_mode;      /* mode we are syncing to peer in */
159         uint8_t  leap;           /* system leap bits */
160         uint8_t  stratum;        /* our stratum */
161         int8_t   precision;      /* local clock precision */
162         int32_t  rootdelay;      /* distance from sync source */
163         uint32_t rootdispersion; /* dispersion from sync source */
164         uint32_t refid;          /* reference ID of sync source */
165         uint64_t reftime;        /* system reference time */
166         uint32_t poll;           /* system poll interval */
167         uint8_t  flags;          /* system flags */
168         uint8_t  unused1;        /* unused */
169         uint8_t  unused2;        /* unused */
170         uint8_t  unused3;        /* unused */
171         int32_t  bdelay;         /* default broadcast offset */
172         int32_t  frequency;      /* frequency residual (scaled ppm)  */
173         uint64_t authdelay;      /* default authentication delay */
174         uint32_t stability;      /* clock stability (scaled ppm) */
175         int32_t  v6_flag;        /* is this v6 or not */
176         int32_t  unused4;        /* unused, padding for peer6 */
177         struct in6_addr peer6;   /* system peer address (v6) */
178 };
179 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
180  * End of the copied stuff..                                         *
181  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
183 static void ntpd_init (void)
185         return;
188 static void ntpd_write_time_offset (char *host, char *inst, char *val)
190         char buf[256];
191         int  status;
193         status = snprintf (buf, 256, time_offset_file, inst);
194         if ((status < 1) || (status >= 256))
195                 return;
197         rrd_update_file (host, buf, val,
198                         time_offset_ds_def, time_offset_ds_num);
201 static void ntpd_write_frequency_offset (char *host, char *inst, char *val)
203         char buf[256];
204         int  status;
206         status = snprintf (buf, 256, frequency_offset_file, inst);
207         if ((status < 1) || (status >= 256))
208                 return;
210         rrd_update_file (host, buf, val,
211                         frequency_offset_ds_def, frequency_offset_ds_num);
214 #if NTPD_HAVE_READ
215 static void ntpd_submit (char *type, char *inst, double value)
217         char buf[256];
219         if (snprintf (buf, 256, "%u:%.2f", (unsigned int) curtime, value) >= 256)
220                 return;
222         DBG ("type = %s; inst = %s; value = %s;",
223                         type, inst, buf);
225         plugin_submit (type, inst, buf);
228 /* returns `tv0 - tv1' in milliseconds or 0 if `tv1 > tv0' */
229 static int timeval_sub (const struct timeval *tv0, const struct timeval *tv1)
231         int sec;
232         int usec;
234         if ((tv0->tv_sec < tv1->tv_sec)
235                         || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
236                 return (0);
238         sec  = tv0->tv_sec  - tv1->tv_sec;
239         usec = tv0->tv_usec - tv1->tv_usec;
241         while (usec < 0)
242         {
243                 usec += 1000000;
244                 sec  -= 1;
245         }
247         if (sec < 0)
248                 return (0);
250         return ((sec * 1000) + ((usec + 500) / 1000));
253 static int ntpd_connect (void)
255         char *host;
256         char *port;
258         struct addrinfo  ai_hints;
259         struct addrinfo *ai_list;
260         struct addrinfo *ai_ptr;
261         int              status;
263         if (sock_descr >= 0)
264         {
265                 DBG ("A socket already exists.");
266                 return (sock_descr);
267         }
269         host = ntpd_host;
270         if (host == NULL)
271                 host = NTPD_DEFAULT_HOST;
273         port = ntpd_port;
274         if (port == NULL)
275                 port = NTPD_DEFAULT_PORT;
277         memset (&ai_hints, '\0', sizeof (ai_hints));
278         ai_hints.ai_flags    = AI_ADDRCONFIG;
279         ai_hints.ai_family   = PF_UNSPEC;
280         ai_hints.ai_socktype = SOCK_DGRAM;
281         ai_hints.ai_protocol = IPPROTO_UDP;
283         if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
284         {
285                 DBG ("getaddrinfo (%s, %s): %s",
286                                 host, port,
287                                 status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
288                 syslog (LOG_ERR, "ntpd plugin: getaddrinfo (%s, %s): %s",
289                                 host, port,
290                                 status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
291                 return (-1);
292         }
294         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
295         {
296                 /* create our socket descriptor */
297                 if ((sock_descr = socket (ai_ptr->ai_family,
298                                                 ai_ptr->ai_socktype,
299                                                 ai_ptr->ai_protocol)) < 0)
300                         continue;
302                 /* connect to the ntpd */
303                 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
304                 {
305                         close (sock_descr);
306                         sock_descr = -1;
307                         continue;
308                 }
310                 break;
311         }
313         freeaddrinfo (ai_list);
315         if (sock_descr < 0)
316         {
317                 DBG ("Unable to connect to server.");
318                 syslog (LOG_ERR, "ntpd plugin: Unable to connect to server.");
319         }
321         return (sock_descr);
324 /* For a description of the arguments see `ntpd_do_query' below. */
325 static int ntpd_receive_response (int req_code, int *res_items, int *res_size,
326                 char **res_data, int res_item_size)
328         int              sd;
329         struct pollfd    poll_s;
330         struct resp_pkt  res;
331         int              status;
332         int              done;
333         int              i;
335         char            *items;
336         size_t           items_num;
338         struct timeval   time_end;
339         struct timeval   time_now;
340         int              timeout;
342         int              pkt_item_num;        /* items in this packet */
343         int              pkt_item_len;        /* size of the items in this packet */
344         int              pkt_sequence;
345         char             pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
346         int              pkt_recvd_num;       /* number of packets that have been received */
347         int              pkt_lastseq;         /* the last sequence number */
348         ssize_t          pkt_padding;         /* Padding in this packet */
350         if ((sd = ntpd_connect ()) < 0)
351                 return (-1);
353         items = NULL;
354         items_num = 0;
356         memset (pkt_recvd, '\0', sizeof (pkt_recvd));
357         pkt_recvd_num = 0;
358         pkt_lastseq   = -1;
360         *res_items = 0;
361         *res_size  = 0;
362         *res_data  = NULL;
364         if (gettimeofday (&time_end, NULL) < 0)
365         {
366                 syslog (LOG_ERR, "ntpd plugin: gettimeofday failed: %s",
367                                 strerror (errno));
368                 return (-1);
369         }
370         time_end.tv_sec++; /* wait for a most one second */
372         done = 0;
373         while (done == 0)
374         {
375                 if (gettimeofday (&time_now, NULL) < 0)
376                 {
377                         syslog (LOG_ERR, "ntpd plugin: gettimeofday failed: %s",
378                                         strerror (errno));
379                         return (-1);
380                 }
382                 /* timeout reached */
383                 if ((timeout = timeval_sub (&time_end, &time_now)) == 0)
384                         break;
386                 poll_s.fd      = sd;
387                 poll_s.events  = POLLIN | POLLPRI;
388                 poll_s.revents = 0;
389                 
390                 status = poll (&poll_s, 1, timeout);
392                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
393                         continue;
395                 if (status < 0)
396                 {
397                         syslog (LOG_ERR, "ntpd plugin: poll failed: %s",
398                                         strerror (errno));
399                         return (-1);
400                 }
402                 if (status == 0) /* timeout */
403                         break;
405                 memset ((void *) &res, '\0', sizeof (res));
406                 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
408                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
409                         continue;
411                 if (status < 0)
412                 {
413                         DBG ("recv(2) failed: %s", strerror (errno));
414                         return (-1);
415                 }
417                 /* 
418                  * Do some sanity checks first
419                  */
420                 if (status < RESP_HEADER_SIZE)
421                 {
422                         syslog (LOG_WARNING, "ntpd plugin: Short (%i bytes) packet received",
423                                         (int) status);
424                         continue;
425                 }
426                 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
427                 {
428                         syslog (LOG_NOTICE, "ntpd plugin: Packet received with mode %i",
429                                         INFO_MODE (res.rm_vn_mode));
430                         continue;
431                 }
432                 if (INFO_IS_AUTH (res.auth_seq))
433                 {
434                         syslog (LOG_NOTICE, "ntpd plugin: Encrypted packet received");
435                         continue;
436                 }
437                 if (!ISRESPONSE (res.rm_vn_mode))
438                 {
439                         syslog (LOG_NOTICE, "ntpd plugin: Received request packet, "
440                                         "wanted response");
441                         continue;
442                 }
443                 if (INFO_MBZ (res.mbz_itemsize))
444                 {
445                         syslog (LOG_WARNING, "ntpd plugin: Received packet with nonzero "
446                                         "MBZ field!");
447                         continue;
448                 }
449                 if (res.implementation != IMPL_XNTPD)
450                 {
451                         syslog (LOG_WARNING, "ntpd plugin: Asked for request of type %i, "
452                                         "got %i", (int) IMPL_XNTPD, (int) res.implementation);
453                         continue;
454                 }
456                 /* Check for error code */
457                 if (INFO_ERR (res.err_nitems) != 0)
458                 {
459                         syslog (LOG_ERR, "ntpd plugin: Received error code %i",
460                                         (int) INFO_ERR(res.err_nitems));
461                         return ((int) INFO_ERR (res.err_nitems));
462                 }
464                 /* extract number of items in this packet and the size of these items */
465                 pkt_item_num = INFO_NITEMS (res.err_nitems);
466                 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
468                 /* Check if the reported items fit in the packet */
469                 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
470                 {
471                         syslog (LOG_ERR, "ntpd plugin: %i items * %i bytes > "
472                                         "%i bytes - %i bytes header",
473                                         (int) pkt_item_num, (int) pkt_item_len,
474                                         (int) status, (int) RESP_HEADER_SIZE);
475                         continue;
476                 }
478                 /* If this is the first packet (time wise, not sequence wise),
479                  * set `res_size'. If it's not the first packet check if the
480                  * items have the same size. Discard invalid packets. */
481                 if (items_num == 0) /* first packet */
482                 {
483                         *res_size = pkt_item_len;
484                 }
485                 else if (*res_size != pkt_item_len)
486                 {
487                         syslog (LOG_ERR, "Item sizes differ.");
488                         continue;
489                 }
491                 /* Calculate the padding. No idea why there might be any padding.. */
492                 pkt_padding = 0;
493                 if (res_item_size > pkt_item_len)
494                         pkt_padding = res_item_size - pkt_item_len;
496                 /* Extract the sequence number */
497                 pkt_sequence = INFO_SEQ (res.auth_seq);
498                 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
499                 {
500                         syslog (LOG_ERR, "ntpd plugin: Received packet with sequence %i",
501                                         pkt_sequence);
502                         continue;
503                 }
505                 /* Check if this sequence has been received before. If so, discard it. */
506                 if (pkt_recvd[pkt_sequence] != '\0')
507                 {
508                         syslog (LOG_NOTICE, "ntpd plugin: Sequence %i received twice",
509                                         pkt_sequence);
510                         continue;
511                 }
513                 /* If `pkt_lastseq != -1' another packet without `more bit' has
514                  * been received. */
515                 if (!ISMORE (res.rm_vn_mode))
516                 {
517                         if (pkt_lastseq != -1)
518                         {
519                                 syslog (LOG_ERR, "ntpd plugin: Two packets which both "
520                                                 "claim to be the last one in the "
521                                                 "sequence have been received.");
522                                 continue;
523                         }
524                         pkt_lastseq = pkt_sequence;
525                 }
527                 /*
528                  * Enough with the checks. Copy the data now.
529                  * We start by allocating some more memory.
530                  */
531                 items = realloc ((void *) *res_data,
532                                 (items_num + pkt_item_num) * res_item_size);
533                 if (items == NULL)
534                 {
535                         items = *res_data;
536                         syslog (LOG_ERR, "ntpd plugin: realloc failed.");
537                         continue;
538                 }
539                 *res_data = items;
541                 for (i = 0; i < pkt_item_num; i++)
542                 {
543                         void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
544                         void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
546                         /* Set the padding to zeros */
547                         if (pkt_padding != 0)
548                                 memset (dst, '\0', res_item_size);
549                         memcpy (dst, src, (size_t) pkt_item_len);
551                         (*res_items)++;
552                 }
554                 pkt_recvd[pkt_sequence] = (char) 1;
555                 pkt_recvd_num++;
557                 if ((pkt_recvd_num - 1) == pkt_lastseq)
558                         done = 1;
559         } /* while (done == 0) */
561         return (0);
564 /* For a description of the arguments see `ntpd_do_query' below. */
565 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
567         int             sd;
568         struct req_pkt  req;
569         size_t          req_data_len;
570         int             status;
572         assert (req_items >= 0);
573         assert (req_size  >= 0);
575         if ((sd = ntpd_connect ()) < 0)
576                 return (-1);
578         memset ((void *) &req, '\0', sizeof (req));
579         req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
580         req.auth_seq   = AUTH_SEQ (0, 0);
581         req.implementation = IMPL_XNTPD;
582         req.request = (unsigned char) req_code;
584         req_data_len = (size_t) (req_items * req_size);
586         assert (((req_data != NULL) && (req_data_len > 0))
587                         || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
589         req.err_nitems   = ERR_NITEMS (0, req_items);
590         req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
591         
592         if (req_data != NULL)
593                 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
595         status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
596         if (status < 0)
597                 return (status);
599         return (0);
602 /*
603  * ntpd_do_query:
604  *
605  * req_code:      Type of request packet
606  * req_items:     Numver of items in the request
607  * req_size:      Size of one item in the request
608  * req_data:      Data of the request packet
609  * res_items:     Pointer to where the number returned items will be stored.
610  * res_size:      Pointer to where the size of one returned item will be stored.
611  * res_data:      This is where a pointer to the (allocated) data will be stored.
612  * res_item_size: Size of one returned item. (used to calculate padding)
613  *
614  * returns:       zero upon success, non-zero otherwise.
615  */
616 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
617                 int *res_items, int *res_size, char **res_data, int res_item_size)
619         int status;
621         status = ntpd_send_request (req_code, req_items, req_size, req_data);
622         if (status != 0)
623                 return (status);
625         status = ntpd_receive_response (req_code, res_items, res_size, res_data,
626                         res_item_size);
627         return (status);
630 static double ntpd_read_fp (int32_t val_int)
632         double val_double;
634         val_double = ((double) (ntohl (val_int))) / FP_FRAC;
636         return (val_double);
639 static void ntpd_read (void)
641         struct info_sys *is;
642         int              is_num;
643         int              is_size;
644         int              status;
646         is      = NULL;
647         is_num  = 0;
648         is_size = 0;
650         status = ntpd_do_query (REQ_SYS_INFO,
651                         0, 0, NULL, /* request data */
652                         &is_num, &is_size, (char **) ((void *) &is), sizeof (struct info_sys)); /* response data */
654         if (status != 0)
655         {
656                 DBG ("ntpd_do_query failed with status %i", status);
657                 return;
658         }
659         if ((is == NULL) || (is_num == 0) || (is_size == 0))
660         {
661                 DBG ("ntpd_do_query returned: is = %p; is_num = %i; is_size = %i;",
662                                 (void *) is, is_num, is_size);
663                 return;
664         }
666         ntpd_submit ("ntpd_frequency_offset", "loop", ntpd_read_fp (is->frequency));
668         free (is);
669         is = NULL;
671         return;
673 #else
674 # define ntpd_read NULL
675 #endif /* NTPD_HAVE_READ */
677 void module_register (void)
679         plugin_register (MODULE_NAME, ntpd_init, ntpd_read, NULL);
680         plugin_register ("ntpd_time_offset", NULL, NULL, ntpd_write_time_offset);
681         plugin_register ("ntpd_frequency_offset", NULL, NULL, ntpd_write_frequency_offset);
684 #undef MODULE_NAME