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