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