Code

common.c: fields_num is unsigned
[collectd.git] / src / ntpd.c
1 /**
2  * collectd - src/ntpd.c
3  * Copyright (C) 2006-2012  Florian octo Forster
4  *
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:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
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.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  **/
27 #define _DEFAULT_SOURCE
28 #define _BSD_SOURCE /* For NI_MAXHOST */
30 #include "collectd.h"
31 #include "common.h"
32 #include "plugin.h"
33 #include "configfile.h"
35 #if HAVE_STDINT_H
36 # include <stdint.h>
37 #endif
38 #if HAVE_NETDB_H
39 # include <netdb.h>
40 #endif
41 #if HAVE_NETINET_IN_H
42 # include <netinet/in.h>
43 #endif
44 #if HAVE_ARPA_INET_H
45 # include <arpa/inet.h> /* inet_ntoa */
46 #endif
47 #if HAVE_NETINET_TCP_H
48 # include <netinet/tcp.h>
49 #endif
50 #if HAVE_POLL_H
51 # include <poll.h>
52 #endif
54 static const char *config_keys[] =
55 {
56         "Host",
57         "Port",
58         "ReverseLookups",
59         "IncludeUnitID"
60 };
61 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
63 static _Bool do_reverse_lookups = 1;
65 /* This option only exists for backward compatibility. If it is false and two
66  * ntpd peers use the same refclock driver, the plugin will try to write
67  * simultaneous measurements from both to the same type instance. */
68 static _Bool include_unit_id = 0;
70 # define NTPD_DEFAULT_HOST "localhost"
71 # define NTPD_DEFAULT_PORT "123"
72 static int   sock_descr = -1;
73 static char *ntpd_host = NULL;
74 static char  ntpd_port[16];
76 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
77  * The following definitions were copied from the NTPd distribution  *
78  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
79 #define MAXFILENAME 128
80 #define MAXSEQ  127
81 #define MODE_PRIVATE 7
82 #define NTP_OLDVERSION ((uint8_t) 1) /* oldest credible version */
83 #define IMPL_XNTPD 3
84 #define FP_FRAC 65536.0
86 #define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */
87 #define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */
89 /* This structure is missing the message authentication code, since collectd
90  * doesn't use it. */
91 struct req_pkt
92 {
93         uint8_t  rm_vn_mode;
94         uint8_t  auth_seq;
95         uint8_t  implementation;                /* implementation number */
96         uint8_t  request;                       /* request number */
97         uint16_t err_nitems;            /* error code/number of data items */
98         uint16_t mbz_itemsize;          /* item size */
99         char     data[MAXFILENAME + 48];        /* data area [32 prev](176 byte max) */
100                                         /* struct conf_peer must fit */
101 };
102 #define REQ_LEN_NOMAC (sizeof(struct req_pkt))
104 /*
105  * A response packet.  The length here is variable, this is a
106  * maximally sized one.  Note that this implementation doesn't
107  * authenticate responses.
108  */
109 #define RESP_HEADER_SIZE        (8)
110 #define RESP_DATA_SIZE          (500)
112 struct resp_pkt
114         uint8_t  rm_vn_mode;           /* response, more, version, mode */
115         uint8_t  auth_seq;             /* key, sequence number */
116         uint8_t  implementation;       /* implementation number */
117         uint8_t  request;              /* request number */
118         uint16_t err_nitems;           /* error code/number of data items */
119         uint16_t mbz_itemsize;         /* item size */
120         char     data[RESP_DATA_SIZE]; /* data area */
121 };
123 /*
124  * Bit setting macros for multifield items.
125  */
126 #define RESP_BIT        0x80
127 #define MORE_BIT        0x40
129 #define ISRESPONSE(rm_vn_mode)  (((rm_vn_mode)&RESP_BIT)!=0)
130 #define ISMORE(rm_vn_mode)      (((rm_vn_mode)&MORE_BIT)!=0)
131 #define INFO_VERSION(rm_vn_mode) ((uint8_t)(((rm_vn_mode)>>3)&0x7))
132 #define INFO_MODE(rm_vn_mode)   ((rm_vn_mode)&0x7)
134 #define RM_VN_MODE(resp, more, version)         \
135                                 ((uint8_t)(((resp)?RESP_BIT:0)\
136                                 |((more)?MORE_BIT:0)\
137                                 |((version?version:(NTP_OLDVERSION+1))<<3)\
138                                 |(MODE_PRIVATE)))
140 #define INFO_IS_AUTH(auth_seq)  (((auth_seq) & 0x80) != 0)
141 #define INFO_SEQ(auth_seq)      ((auth_seq)&0x7f)
142 #define AUTH_SEQ(auth, seq)     ((uint8_t)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
144 #define INFO_ERR(err_nitems)    ((uint16_t)((ntohs(err_nitems)>>12)&0xf))
145 #define INFO_NITEMS(err_nitems) ((uint16_t)(ntohs(err_nitems)&0xfff))
146 #define ERR_NITEMS(err, nitems) (htons((uint16_t)((((uint16_t)(err)<<12)&0xf000)\
147                                 |((uint16_t)(nitems)&0xfff))))
149 #define INFO_MBZ(mbz_itemsize)  ((ntohs(mbz_itemsize)>>12)&0xf)
150 #define INFO_ITEMSIZE(mbz_itemsize)     ((uint16_t)(ntohs(mbz_itemsize)&0xfff))
151 #define MBZ_ITEMSIZE(itemsize)  (htons((uint16_t)(itemsize)))
153 /* negate a long float type */
154 #define M_NEG(v_i, v_f) \
155         do { \
156                 if ((v_f) == 0) \
157                 (v_i) = -((uint32_t)(v_i)); \
158                 else { \
159                         (v_f) = -((uint32_t)(v_f)); \
160                         (v_i) = ~(v_i); \
161                 } \
162         } while(0)
163 /* l_fp to double */
164 #define M_LFPTOD(r_i, r_uf, d) \
165         do { \
166                 register int32_t  ri; \
167                 register uint32_t rf; \
168                 \
169                 ri = (r_i); \
170                 rf = (r_uf); \
171                 if (ri < 0) { \
172                         M_NEG(ri, rf); \
173                         (d) = -((double) ri + ((double) rf) / 4294967296.0); \
174                 } else { \
175                         (d) = (double) ri + ((double) rf) / 4294967296.0; \
176                 } \
177         } while (0)
179 #define REQ_PEER_LIST_SUM 1
180 struct info_peer_summary
182         uint32_t dstadr;         /* local address (zero for undetermined) */
183         uint32_t srcadr;         /* source address */
184         uint16_t srcport;        /* source port */
185         uint8_t stratum;         /* stratum of peer */
186         int8_t hpoll;            /* host polling interval */
187         int8_t ppoll;            /* peer polling interval */
188         uint8_t reach;           /* reachability register */
189         uint8_t flags;           /* flags, from above */
190         uint8_t hmode;           /* peer mode */
191         int32_t  delay;          /* peer.estdelay; s_fp */
192         int32_t  offset_int;     /* peer.estoffset; integral part */
193         int32_t  offset_frc;     /* peer.estoffset; fractional part */
194         uint32_t dispersion;     /* peer.estdisp; u_fp */
195         uint32_t v6_flag;        /* is this v6 or not */
196         uint32_t unused1;        /* (unused) padding for dstadr6 */
197         struct in6_addr dstadr6; /* local address (v6) */
198         struct in6_addr srcadr6; /* source address (v6) */
199 };
201 #define REQ_SYS_INFO 4
202 struct info_sys
204         uint32_t peer;           /* system peer address (v4) */
205         uint8_t  peer_mode;      /* mode we are syncing to peer in */
206         uint8_t  leap;           /* system leap bits */
207         uint8_t  stratum;        /* our stratum */
208         int8_t   precision;      /* local clock precision */
209         int32_t  rootdelay;      /* distance from sync source */
210         uint32_t rootdispersion; /* dispersion from sync source */
211         uint32_t refid;          /* reference ID of sync source */
212         uint64_t reftime;        /* system reference time */
213         uint32_t poll;           /* system poll interval */
214         uint8_t  flags;          /* system flags */
215         uint8_t  unused1;        /* unused */
216         uint8_t  unused2;        /* unused */
217         uint8_t  unused3;        /* unused */
218         int32_t  bdelay;         /* default broadcast offset */
219         int32_t  frequency;      /* frequency residual (scaled ppm)  */
220         uint64_t authdelay;      /* default authentication delay */
221         uint32_t stability;      /* clock stability (scaled ppm) */
222         int32_t  v6_flag;        /* is this v6 or not */
223         int32_t  unused4;        /* unused, padding for peer6 */
224         struct in6_addr peer6;   /* system peer address (v6) */
225 };
227 #define REQ_GET_KERNEL 38
228 struct info_kernel
230         int32_t  offset;
231         int32_t  freq;
232         int32_t  maxerror;
233         int32_t  esterror;
234         uint16_t status;
235         uint16_t shift;
236         int32_t  constant;
237         int32_t  precision;
238         int32_t  tolerance;
239         /* pps stuff */
240         int32_t  ppsfreq;
241         int32_t  jitter;
242         int32_t  stabil;
243         int32_t  jitcnt;
244         int32_t  calcnt;
245         int32_t  errcnt;
246         int32_t  stbcnt;
247 };
249 /* List of reference clock names */
250 static const char *refclock_names[] =
252         "UNKNOWN",    "LOCAL",        "GPS_TRAK",   "WWV_PST",     /*  0- 3 */
253         "SPECTRACOM", "TRUETIME",     "IRIG_AUDIO", "CHU_AUDIO",   /*  4- 7 */
254         "GENERIC",    "GPS_MX4200",   "GPS_AS2201", "GPS_ARBITER", /*  8-11 */
255         "IRIG_TPRO",  "ATOM_LEITCH",  "MSF_EES",    "GPSTM_TRUE",  /* 12-15 */
256         "GPS_BANC",   "GPS_DATUM",    "ACTS_NIST",  "WWV_HEATH",   /* 16-19 */
257         "GPS_NMEA",   "GPS_VME",      "PPS",        "ACTS_PTB",    /* 20-23 */
258         "ACTS_USNO",  "TRUETIME",     "GPS_HP",     "MSF_ARCRON",  /* 24-27 */
259         "SHM",        "GPS_PALISADE", "GPS_ONCORE", "GPS_JUPITER", /* 28-31 */
260         "CHRONOLOG",  "DUMBCLOCK",    "ULINK_M320", "PCF",         /* 32-35 */
261         "WWV_AUDIO",  "GPS_FG",       "HOPF_S",     "HOPF_P",      /* 36-39 */
262         "JJY",        "TT_IRIG",      "GPS_ZYFER",  "GPS_RIPENCC", /* 40-43 */
263         "NEOCLK4X"                                                 /* 44    */
264 };
265 static size_t refclock_names_num = STATIC_ARRAY_SIZE (refclock_names);
266 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
267  * End of the copied stuff..                                         *
268  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
270 static int ntpd_config (const char *key, const char *value)
272         if (strcasecmp (key, "Host") == 0)
273         {
274                 if (ntpd_host != NULL)
275                         free (ntpd_host);
276                 if ((ntpd_host = strdup (value)) == NULL)
277                         return (1);
278         }
279         else if (strcasecmp (key, "Port") == 0)
280         {
281                 int port = (int) (atof (value));
282                 if ((port > 0) && (port <= 65535))
283                         ssnprintf (ntpd_port, sizeof (ntpd_port),
284                                         "%i", port);
285                 else
286                         sstrncpy (ntpd_port, value, sizeof (ntpd_port));
287         }
288         else if (strcasecmp (key, "ReverseLookups") == 0)
289         {
290                 if (IS_TRUE (value))
291                         do_reverse_lookups = 1;
292                 else
293                         do_reverse_lookups = 0;
294         }
295         else if (strcasecmp (key, "IncludeUnitID") == 0)
296         {
297                 if (IS_TRUE (value))
298                         include_unit_id = 1;
299                 else
300                         include_unit_id = 0;
301         }
302         else
303         {
304                 return (-1);
305         }
307         return (0);
310 static void ntpd_submit (const char *type, const char *type_inst, gauge_t value)
312         value_t values[1];
313         value_list_t vl = VALUE_LIST_INIT;
315         values[0].gauge = value;
317         vl.values = values;
318         vl.values_len = 1;
319         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
320         sstrncpy (vl.plugin, "ntpd", sizeof (vl.plugin));
321         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
322         sstrncpy (vl.type, type, sizeof (vl.type));
323         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
325         plugin_dispatch_values (&vl);
328 /* Each time a peer is polled, ntpd shifts the reach register to the left and
329  * sets the LSB based on whether the peer was reachable. If the LSB is zero,
330  * the values are out of date. */
331 static void ntpd_submit_reach (const char *type, const char *type_inst,
332                 uint8_t reach, gauge_t value)
334         if (!(reach & 1))
335                 value = NAN;
337         ntpd_submit (type, type_inst, value);
340 static int ntpd_connect (void)
342         const char *host;
343         const char *port;
345         struct addrinfo  ai_hints;
346         struct addrinfo *ai_list;
347         struct addrinfo *ai_ptr;
348         int              status;
350         if (sock_descr >= 0)
351                 return (sock_descr);
353         DEBUG ("Opening a new socket");
355         host = ntpd_host;
356         if (host == NULL)
357                 host = NTPD_DEFAULT_HOST;
359         port = ntpd_port;
360         if (strlen (port) == 0)
361                 port = NTPD_DEFAULT_PORT;
363         memset (&ai_hints, '\0', sizeof (ai_hints));
364         ai_hints.ai_flags    = 0;
365 #ifdef AI_ADDRCONFIG
366         ai_hints.ai_flags   |= AI_ADDRCONFIG;
367 #endif
368         ai_hints.ai_family   = PF_UNSPEC;
369         ai_hints.ai_socktype = SOCK_DGRAM;
370         ai_hints.ai_protocol = IPPROTO_UDP;
372         if ((status = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
373         {
374                 char errbuf[1024];
375                 ERROR ("ntpd plugin: getaddrinfo (%s, %s): %s",
376                                 host, port,
377                                 (status == EAI_SYSTEM)
378                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
379                                 : gai_strerror (status));
380                 return (-1);
381         }
383         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
384         {
385                 /* create our socket descriptor */
386                 if ((sock_descr = socket (ai_ptr->ai_family,
387                                                 ai_ptr->ai_socktype,
388                                                 ai_ptr->ai_protocol)) < 0)
389                         continue;
391                 /* connect to the ntpd */
392                 if (connect (sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen))
393                 {
394                         close (sock_descr);
395                         sock_descr = -1;
396                         continue;
397                 }
399                 break;
400         }
402         freeaddrinfo (ai_list);
404         if (sock_descr < 0)
405         {
406                 ERROR ("ntpd plugin: Unable to connect to server.");
407         }
409         return (sock_descr);
412 /* For a description of the arguments see `ntpd_do_query' below. */
413 static int ntpd_receive_response (int *res_items, int *res_size,
414                 char **res_data, int res_item_size)
416         int              sd;
417         struct pollfd    poll_s;
418         struct resp_pkt  res;
419         int              status;
420         int              done;
421         int              i;
423         char            *items;
424         size_t           items_num;
426         struct timeval   time_end;
427         struct timeval   time_now;
428         int              timeout;
430         int              pkt_item_num;        /* items in this packet */
431         int              pkt_item_len;        /* size of the items in this packet */
432         int              pkt_sequence;
433         char             pkt_recvd[MAXSEQ+1]; /* sequence numbers that have been received */
434         int              pkt_recvd_num;       /* number of packets that have been received */
435         int              pkt_lastseq;         /* the last sequence number */
436         ssize_t          pkt_padding;         /* Padding in this packet */
438         if ((sd = ntpd_connect ()) < 0)
439                 return (-1);
441         items = NULL;
442         items_num = 0;
444         memset (pkt_recvd, '\0', sizeof (pkt_recvd));
445         pkt_recvd_num = 0;
446         pkt_lastseq   = -1;
448         *res_items = 0;
449         *res_size  = 0;
450         *res_data  = NULL;
452         if (gettimeofday (&time_end, NULL) < 0)
453         {
454                 char errbuf[1024];
455                 ERROR ("ntpd plugin: gettimeofday failed: %s",
456                                 sstrerror (errno, errbuf, sizeof (errbuf)));
457                 return (-1);
458         }
459         time_end.tv_sec++; /* wait for a most one second */
461         done = 0;
462         while (done == 0)
463         {
464                 struct timeval time_left;
466                 if (gettimeofday (&time_now, NULL) < 0)
467                 {
468                         char errbuf[1024];
469                         ERROR ("ntpd plugin: gettimeofday failed: %s",
470                                         sstrerror (errno, errbuf, sizeof (errbuf)));
471                         return (-1);
472                 }
474                 if (timeval_cmp (time_end, time_now, &time_left) <= 0)
475                         timeout = 0;
476                 else
477                         timeout = 1000 * time_left.tv_sec
478                                 + ((time_left.tv_usec + 500) / 1000);
480                 /* timeout reached */
481                 if (timeout <= 0)
482                         break;
484                 poll_s.fd      = sd;
485                 poll_s.events  = POLLIN | POLLPRI;
486                 poll_s.revents = 0;
488                 DEBUG ("Polling for %ims", timeout);
489                 status = poll (&poll_s, 1, timeout);
491                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
492                         continue;
494                 if (status < 0)
495                 {
496                         char errbuf[1024];
497                         ERROR ("ntpd plugin: poll failed: %s",
498                                         sstrerror (errno, errbuf, sizeof (errbuf)));
499                         return (-1);
500                 }
502                 if (status == 0) /* timeout */
503                 {
504                         DEBUG ("timeout reached.");
505                         break;
506                 }
508                 memset ((void *) &res, '\0', sizeof (res));
509                 status = recv (sd, (void *) &res, sizeof (res), 0 /* no flags */);
511                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
512                         continue;
514                 if (status < 0)
515                 {
516                         char errbuf[1024];
517                         INFO ("recv(2) failed: %s",
518                                         sstrerror (errno, errbuf, sizeof (errbuf)));
519                         DEBUG ("Closing socket #%i", sd);
520                         close (sd);
521                         sock_descr = sd = -1;
522                         return (-1);
523                 }
525                 DEBUG ("recv'd %i bytes", status);
527                 /*
528                  * Do some sanity checks first
529                  */
530                 if (status < RESP_HEADER_SIZE)
531                 {
532                         WARNING ("ntpd plugin: Short (%i bytes) packet received",
533                                         (int) status);
534                         continue;
535                 }
536                 if (INFO_MODE (res.rm_vn_mode) != MODE_PRIVATE)
537                 {
538                         NOTICE ("ntpd plugin: Packet received with mode %i",
539                                         INFO_MODE (res.rm_vn_mode));
540                         continue;
541                 }
542                 if (INFO_IS_AUTH (res.auth_seq))
543                 {
544                         NOTICE ("ntpd plugin: Encrypted packet received");
545                         continue;
546                 }
547                 if (!ISRESPONSE (res.rm_vn_mode))
548                 {
549                         NOTICE ("ntpd plugin: Received request packet, "
550                                         "wanted response");
551                         continue;
552                 }
553                 if (INFO_MBZ (res.mbz_itemsize))
554                 {
555                         WARNING ("ntpd plugin: Received packet with nonzero "
556                                         "MBZ field!");
557                         continue;
558                 }
559                 if (res.implementation != IMPL_XNTPD)
560                 {
561                         WARNING ("ntpd plugin: Asked for request of type %i, "
562                                         "got %i", (int) IMPL_XNTPD, (int) res.implementation);
563                         continue;
564                 }
566                 /* Check for error code */
567                 if (INFO_ERR (res.err_nitems) != 0)
568                 {
569                         ERROR ("ntpd plugin: Received error code %i",
570                                         (int) INFO_ERR(res.err_nitems));
571                         return ((int) INFO_ERR (res.err_nitems));
572                 }
574                 /* extract number of items in this packet and the size of these items */
575                 pkt_item_num = INFO_NITEMS (res.err_nitems);
576                 pkt_item_len = INFO_ITEMSIZE (res.mbz_itemsize);
577                 DEBUG ("pkt_item_num = %i; pkt_item_len = %i;",
578                                 pkt_item_num, pkt_item_len);
580                 /* Check if the reported items fit in the packet */
581                 if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE))
582                 {
583                         ERROR ("ntpd plugin: %i items * %i bytes > "
584                                         "%i bytes - %i bytes header",
585                                         (int) pkt_item_num, (int) pkt_item_len,
586                                         (int) status, (int) RESP_HEADER_SIZE);
587                         continue;
588                 }
590                 if (pkt_item_len > res_item_size)
591                 {
592                         ERROR ("ntpd plugin: (pkt_item_len = %i) "
593                                         ">= (res_item_size = %i)",
594                                         pkt_item_len, res_item_size);
595                         continue;
596                 }
598                 /* If this is the first packet (time wise, not sequence wise),
599                  * set `res_size'. If it's not the first packet check if the
600                  * items have the same size. Discard invalid packets. */
601                 if (items_num == 0) /* first packet */
602                 {
603                         DEBUG ("*res_size = %i", pkt_item_len);
604                         *res_size = pkt_item_len;
605                 }
606                 else if (*res_size != pkt_item_len)
607                 {
608                         DEBUG ("Error: *res_size = %i; pkt_item_len = %i;",
609                                         *res_size, pkt_item_len);
610                         ERROR ("Item sizes differ.");
611                         continue;
612                 }
614                 /*
615                  * Because the items in the packet may be smaller than the
616                  * items requested, the following holds true:
617                  */
618                 assert ((*res_size == pkt_item_len)
619                                 && (pkt_item_len <= res_item_size));
621                 /* Calculate the padding. No idea why there might be any padding.. */
622                 pkt_padding = 0;
623                 if (pkt_item_len < res_item_size)
624                         pkt_padding = res_item_size - pkt_item_len;
625                 DEBUG ("res_item_size = %i; pkt_padding = %zi;",
626                                 res_item_size, pkt_padding);
628                 /* Extract the sequence number */
629                 pkt_sequence = INFO_SEQ (res.auth_seq);
630                 if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ))
631                 {
632                         ERROR ("ntpd plugin: Received packet with sequence %i",
633                                         pkt_sequence);
634                         continue;
635                 }
637                 /* Check if this sequence has been received before. If so, discard it. */
638                 if (pkt_recvd[pkt_sequence] != '\0')
639                 {
640                         NOTICE ("ntpd plugin: Sequence %i received twice",
641                                         pkt_sequence);
642                         continue;
643                 }
645                 /* If `pkt_lastseq != -1' another packet without `more bit' has
646                  * been received. */
647                 if (!ISMORE (res.rm_vn_mode))
648                 {
649                         if (pkt_lastseq != -1)
650                         {
651                                 ERROR ("ntpd plugin: Two packets which both "
652                                                 "claim to be the last one in the "
653                                                 "sequence have been received.");
654                                 continue;
655                         }
656                         pkt_lastseq = pkt_sequence;
657                         DEBUG ("Last sequence = %i;", pkt_lastseq);
658                 }
660                 /*
661                  * Enough with the checks. Copy the data now.
662                  * We start by allocating some more memory.
663                  */
664                 DEBUG ("realloc (%p, %zu)", (void *) *res_data,
665                                 (items_num + pkt_item_num) * res_item_size);
666                 items = realloc ((void *) *res_data,
667                                 (items_num + pkt_item_num) * res_item_size);
668                 if (items == NULL)
669                 {
670                         ERROR ("ntpd plugin: realloc failed.");
671                         continue;
672                 }
673                 items_num += pkt_item_num;
674                 *res_data = items;
676                 for (i = 0; i < pkt_item_num; i++)
677                 {
678                         /* dst: There are already `*res_items' items with
679                          *      res_item_size bytes each in in `*res_data'. Set
680                          *      dst to the first byte after that. */
681                         void *dst = (void *) (*res_data + ((*res_items) * res_item_size));
682                         /* src: We use `pkt_item_len' to calculate the offset
683                          *      from the beginning of the packet, because the
684                          *      items in the packet may be smaller than the
685                          *      items that were requested. We skip `i' such
686                          *      items. */
687                         void *src = (void *) (((char *) res.data) + (i * pkt_item_len));
689                         /* Set the padding to zeros */
690                         if (pkt_padding != 0)
691                                 memset (dst, '\0', res_item_size);
692                         memcpy (dst, src, (size_t) pkt_item_len);
694                         /* Increment `*res_items' by one, so `dst' will end up
695                          * one further in the next round. */
696                         (*res_items)++;
697                 } /* for (pkt_item_num) */
699                 pkt_recvd[pkt_sequence] = (char) 1;
700                 pkt_recvd_num++;
702                 if ((pkt_recvd_num - 1) == pkt_lastseq)
703                         done = 1;
704         } /* while (done == 0) */
706         return (0);
707 } /* int ntpd_receive_response */
709 /* For a description of the arguments see `ntpd_do_query' below. */
710 static int ntpd_send_request (int req_code, int req_items, int req_size, char *req_data)
712         int             sd;
713         struct req_pkt  req;
714         size_t          req_data_len;
715         int             status;
717         assert (req_items >= 0);
718         assert (req_size  >= 0);
720         if ((sd = ntpd_connect ()) < 0)
721                 return (-1);
723         memset ((void *) &req, '\0', sizeof (req));
724         req.rm_vn_mode = RM_VN_MODE(0, 0, 0);
725         req.auth_seq   = AUTH_SEQ (0, 0);
726         req.implementation = IMPL_XNTPD;
727         req.request = (unsigned char) req_code;
729         req_data_len = (size_t) (req_items * req_size);
731         assert (((req_data != NULL) && (req_data_len > 0))
732                         || ((req_data == NULL) && (req_items == 0) && (req_size == 0)));
734         req.err_nitems   = ERR_NITEMS (0, req_items);
735         req.mbz_itemsize = MBZ_ITEMSIZE (req_size);
737         if (req_data != NULL)
738                 memcpy ((void *) req.data, (const void *) req_data, req_data_len);
740         DEBUG ("req_items = %i; req_size = %i; req_data = %p;",
741                         req_items, req_size, (void *) req_data);
743         status = swrite (sd, (const char *) &req, REQ_LEN_NOMAC);
744         if (status < 0)
745         {
746                 DEBUG ("`swrite' failed. Closing socket #%i", sd);
747                 close (sd);
748                 sock_descr = sd = -1;
749                 return (status);
750         }
752         return (0);
755 /*
756  * ntpd_do_query:
757  *
758  * req_code:      Type of request packet
759  * req_items:     Numver of items in the request
760  * req_size:      Size of one item in the request
761  * req_data:      Data of the request packet
762  * res_items:     Pointer to where the number returned items will be stored.
763  * res_size:      Pointer to where the size of one returned item will be stored.
764  * res_data:      This is where a pointer to the (allocated) data will be stored.
765  * res_item_size: Size of one returned item. (used to calculate padding)
766  *
767  * returns:       zero upon success, non-zero otherwise.
768  */
769 static int ntpd_do_query (int req_code, int req_items, int req_size, char *req_data,
770                 int *res_items, int *res_size, char **res_data, int res_item_size)
772         int status;
774         status = ntpd_send_request (req_code, req_items, req_size, req_data);
775         if (status != 0)
776                 return (status);
778         status = ntpd_receive_response (res_items, res_size, res_data,
779                         res_item_size);
780         return (status);
783 static double ntpd_read_fp (int32_t val_int)
785         double val_double;
787         val_int = ntohl (val_int);
788         val_double = ((double) val_int) / FP_FRAC;
790         return (val_double);
793 static uint32_t ntpd_get_refclock_id (struct info_peer_summary const *peer_info)
795         uint32_t addr = ntohl (peer_info->srcadr);
796         uint32_t refclock_id = (addr >> 8) & 0x00FF;
798         return (refclock_id);
801 static int ntpd_get_name_from_address (char *buffer, size_t buffer_size,
802                 struct info_peer_summary const *peer_info, _Bool do_reverse_lookup)
804         struct sockaddr_storage sa;
805         socklen_t sa_len;
806         int flags = 0;
807         int status;
809         memset (&sa, 0, sizeof (sa));
811         if (peer_info->v6_flag)
812         {
813                 struct sockaddr_in6 sa6;
815                 assert (sizeof (sa) >= sizeof (sa6));
817                 memset (&sa6, 0, sizeof (sa6));
818                 sa6.sin6_family = AF_INET6;
819                 sa6.sin6_port = htons (123);
820                 memcpy (&sa6.sin6_addr, &peer_info->srcadr6,
821                                 sizeof (struct in6_addr));
822                 sa_len = sizeof (sa6);
824                 memcpy (&sa, &sa6, sizeof (sa6));
825         }
826         else
827         {
828                 struct sockaddr_in sa4;
830                 assert (sizeof (sa) >= sizeof (sa4));
832                 memset (&sa4, 0, sizeof (sa4));
833                 sa4.sin_family = AF_INET;
834                 sa4.sin_port = htons (123);
835                 memcpy (&sa4.sin_addr, &peer_info->srcadr,
836                                 sizeof (struct in_addr));
837                 sa_len = sizeof (sa4);
839                 memcpy (&sa, &sa4, sizeof (sa4));
840         }
842         if (!do_reverse_lookup)
843                 flags |= NI_NUMERICHOST;
845         status = getnameinfo ((struct sockaddr const *) &sa, sa_len,
846                         buffer, buffer_size,
847                         NULL, 0, /* No port name */
848                         flags);
849         if (status != 0)
850         {
851                 char errbuf[1024];
852                 ERROR ("ntpd plugin: getnameinfo failed: %s",
853                                 (status == EAI_SYSTEM)
854                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
855                                 : gai_strerror (status));
856                 return (-1);
857         }
859         return (0);
860 } /* ntpd_get_name_from_address */
862 static int ntpd_get_name_refclock (char *buffer, size_t buffer_size,
863                 struct info_peer_summary const *peer_info)
865         uint32_t refclock_id = ntpd_get_refclock_id (peer_info);
866         uint32_t unit_id = ntohl (peer_info->srcadr) & 0x00FF;
868         if (((size_t) refclock_id) >= refclock_names_num)
869                 return (ntpd_get_name_from_address (buffer, buffer_size,
870                                         peer_info,
871                                         /* do_reverse_lookup = */ 0));
873         if (include_unit_id)
874                 ssnprintf (buffer, buffer_size, "%s-%"PRIu32,
875                                 refclock_names[refclock_id], unit_id);
876         else
877                 sstrncpy (buffer, refclock_names[refclock_id], buffer_size);
879         return (0);
880 } /* int ntpd_get_name_refclock */
882 static int ntpd_get_name (char *buffer, size_t buffer_size,
883                 struct info_peer_summary const *peer_info)
885         uint32_t addr = ntohl (peer_info->srcadr);
887         if (!peer_info->v6_flag && ((addr & REFCLOCK_MASK) == REFCLOCK_ADDR))
888                 return (ntpd_get_name_refclock (buffer, buffer_size,
889                                         peer_info));
890         else
891                 return (ntpd_get_name_from_address (buffer, buffer_size,
892                                         peer_info, do_reverse_lookups));
893 } /* int ntpd_addr_to_name */
895 static int ntpd_read (void)
897         struct info_kernel *ik;
898         int                 ik_num;
899         int                 ik_size;
901         struct info_peer_summary *ps;
902         int                       ps_num;
903         int                       ps_size;
905         gauge_t offset_loop;
906         gauge_t freq_loop;
907         gauge_t offset_error;
909         int status;
910         int i;
912         /* On Linux, if the STA_NANO bit is set in ik->status, then ik->offset
913          * is is nanoseconds, otherwise it's microseconds.
914          * TODO(octo): STA_NANO is defined in the Linux specific <sys/timex.h> header. */
915         double scale_loop  = 1e-6;
916         double scale_error = 1e-6;
918         ik      = NULL;
919         ik_num  = 0;
920         ik_size = 0;
922         status = ntpd_do_query (REQ_GET_KERNEL,
923                         0, 0, NULL, /* request data */
924                         &ik_num, &ik_size, (char **) ((void *) &ik), /* response data */
925                         sizeof (struct info_kernel));
926         if (status != 0)
927         {
928                 ERROR ("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", status);
929                 return (status);
930         }
931         else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0))
932         {
933                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
934                                 "(ik = %p; ik_num = %i; ik_size = %i)",
935                                 (void *) ik, ik_num, ik_size);
936                 return (-1);
937         }
939         /* kerninfo -> estimated error */
940         offset_loop  = scale_loop * ((gauge_t) ntohl (ik->offset));
941         freq_loop    = ntpd_read_fp (ik->freq);
942         offset_error = scale_error * ((gauge_t) ntohl (ik->esterror));
944         DEBUG ("info_kernel:\n"
945                         "  pll offset    = %.8g\n"
946                         "  pll frequency = %.8g\n" /* drift compensation */
947                         "  est error     = %.8g\n",
948                         offset_loop, freq_loop, offset_error);
950         ntpd_submit ("frequency_offset", "loop",  freq_loop);
951         ntpd_submit ("time_offset",      "loop",  offset_loop);
952         ntpd_submit ("time_offset",      "error", offset_error);
954         free (ik);
955         ik = NULL;
957         status = ntpd_do_query (REQ_PEER_LIST_SUM,
958                         0, 0, NULL, /* request data */
959                         &ps_num, &ps_size, (char **) ((void *) &ps), /* response data */
960                         sizeof (struct info_peer_summary));
961         if (status != 0)
962         {
963                 ERROR ("ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", status);
964                 return (status);
965         }
966         else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0))
967         {
968                 ERROR ("ntpd plugin: ntpd_do_query returned unexpected data. "
969                                 "(ps = %p; ps_num = %i; ps_size = %i)",
970                                 (void *) ps, ps_num, ps_size);
971                 return (-1);
972         }
974         for (i = 0; i < ps_num; i++)
975         {
976                 struct info_peer_summary *ptr;
977                 double offset;
979                 char peername[NI_MAXHOST];
980                 uint32_t refclock_id;
982                 ptr = ps + i;
984                 status = ntpd_get_name (peername, sizeof (peername), ptr);
985                 if (status != 0)
986                 {
987                         ERROR ("ntpd plugin: Determining name of peer failed.");
988                         continue;
989                 }
991                 refclock_id = ntpd_get_refclock_id (ptr);
993                 /* Convert the `long floating point' offset value to double */
994                 M_LFPTOD (ntohl (ptr->offset_int), ntohl (ptr->offset_frc), offset);
996                 DEBUG ("peer %i:\n"
997                                 "  peername   = %s\n"
998                                 "  srcadr     = 0x%08x\n"
999                                 "  reach      = 0%03o\n"
1000                                 "  delay      = %f\n"
1001                                 "  offset_int = %i\n"
1002                                 "  offset_frc = %i\n"
1003                                 "  offset     = %f\n"
1004                                 "  dispersion = %f\n",
1005                                 i,
1006                                 peername,
1007                                 ntohl (ptr->srcadr),
1008                                 ptr->reach,
1009                                 ntpd_read_fp (ptr->delay),
1010                                 ntohl (ptr->offset_int),
1011                                 ntohl (ptr->offset_frc),
1012                                 offset,
1013                                 ntpd_read_fp (ptr->dispersion));
1015                 if (refclock_id != 1) /* not the system clock (offset will always be zero.. */
1016                         ntpd_submit_reach ("time_offset", peername, ptr->reach,
1017                                         offset);
1018                 ntpd_submit_reach ("time_dispersion", peername, ptr->reach,
1019                                 ntpd_read_fp (ptr->dispersion));
1020                 if (refclock_id == 0) /* not a reference clock */
1021                         ntpd_submit_reach ("delay", peername, ptr->reach,
1022                                         ntpd_read_fp (ptr->delay));
1023         }
1025         free (ps);
1026         ps = NULL;
1028         return (0);
1029 } /* int ntpd_read */
1031 void module_register (void)
1033         plugin_register_config ("ntpd", ntpd_config,
1034                         config_keys, config_keys_num);
1035         plugin_register_read ("ntpd", ntpd_read);
1036 } /* void module_register */