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