| 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 "plugin.h" |
| 33 |
#include "utils/common/common.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 = true; |
| 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; |
| 65 |
|
| 66 |
#define NTPD_DEFAULT_HOST "localhost" |
| 67 |
#define NTPD_DEFAULT_PORT "123" |
| 68 |
static int sock_descr = -1; |
| 69 |
static char *ntpd_host; |
| 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", "PCI_TSYNC", "GPSD_JSON" /* 44-46 */ |
| 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 = true; |
| 276 |
else |
| 277 |
do_reverse_lookups = false; |
| 278 |
} else if (strcasecmp(key, "IncludeUnitID") == 0) { |
| 279 |
if (IS_TRUE(value)) |
| 280 |
include_unit_id = true; |
| 281 |
else |
| 282 |
include_unit_id = false; |
| 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 |
ERROR("ntpd plugin: getaddrinfo (%s, %s): %s", host, port, |
| 341 |
(status == EAI_SYSTEM) ? STRERRNO : gai_strerror(status)); |
| 342 |
return -1; |
| 343 |
} |
| 344 |
|
| 345 |
for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; |
| 346 |
ai_ptr = ai_ptr->ai_next) { |
| 347 |
/* create our socket descriptor */ |
| 348 |
if ((sock_descr = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, |
| 349 |
ai_ptr->ai_protocol)) < 0) |
| 350 |
continue; |
| 351 |
|
| 352 |
/* connect to the ntpd */ |
| 353 |
if (connect(sock_descr, ai_ptr->ai_addr, ai_ptr->ai_addrlen)) { |
| 354 |
close(sock_descr); |
| 355 |
sock_descr = -1; |
| 356 |
continue; |
| 357 |
} |
| 358 |
|
| 359 |
break; |
| 360 |
} |
| 361 |
|
| 362 |
freeaddrinfo(ai_list); |
| 363 |
|
| 364 |
if (sock_descr < 0) { |
| 365 |
ERROR("ntpd plugin: Unable to connect to server."); |
| 366 |
} |
| 367 |
|
| 368 |
return sock_descr; |
| 369 |
} |
| 370 |
|
| 371 |
/* For a description of the arguments see `ntpd_do_query' below. */ |
| 372 |
static int ntpd_receive_response(int *res_items, int *res_size, char **res_data, |
| 373 |
int res_item_size) { |
| 374 |
int sd; |
| 375 |
struct pollfd poll_s; |
| 376 |
struct resp_pkt res; |
| 377 |
int status; |
| 378 |
int done; |
| 379 |
|
| 380 |
char *items; |
| 381 |
size_t items_num; |
| 382 |
|
| 383 |
struct timeval time_end; |
| 384 |
struct timeval time_now; |
| 385 |
int timeout; |
| 386 |
|
| 387 |
int pkt_item_num; /* items in this packet */ |
| 388 |
int pkt_item_len; /* size of the items in this packet */ |
| 389 |
int pkt_sequence; |
| 390 |
char pkt_recvd[MAXSEQ + 1] = { |
| 391 |
0}; /* sequence numbers that have been received */ |
| 392 |
int pkt_recvd_num; /* number of packets that have been received */ |
| 393 |
int pkt_lastseq; /* the last sequence number */ |
| 394 |
ssize_t pkt_padding; /* Padding in this packet */ |
| 395 |
|
| 396 |
if ((sd = ntpd_connect()) < 0) |
| 397 |
return -1; |
| 398 |
|
| 399 |
items = NULL; |
| 400 |
items_num = 0; |
| 401 |
|
| 402 |
pkt_recvd_num = 0; |
| 403 |
pkt_lastseq = -1; |
| 404 |
|
| 405 |
*res_items = 0; |
| 406 |
*res_size = 0; |
| 407 |
*res_data = NULL; |
| 408 |
|
| 409 |
if (gettimeofday(&time_end, NULL) < 0) { |
| 410 |
ERROR("ntpd plugin: gettimeofday failed: %s", STRERRNO); |
| 411 |
return -1; |
| 412 |
} |
| 413 |
time_end.tv_sec++; /* wait for a most one second */ |
| 414 |
|
| 415 |
done = 0; |
| 416 |
while (done == 0) { |
| 417 |
struct timeval time_left; |
| 418 |
|
| 419 |
if (gettimeofday(&time_now, NULL) < 0) { |
| 420 |
ERROR("ntpd plugin: gettimeofday failed: %s", STRERRNO); |
| 421 |
return -1; |
| 422 |
} |
| 423 |
|
| 424 |
if (timeval_cmp(time_end, time_now, &time_left) <= 0) |
| 425 |
timeout = 0; |
| 426 |
else |
| 427 |
timeout = 1000 * time_left.tv_sec + ((time_left.tv_usec + 500) / 1000); |
| 428 |
|
| 429 |
/* timeout reached */ |
| 430 |
if (timeout <= 0) |
| 431 |
break; |
| 432 |
|
| 433 |
poll_s.fd = sd; |
| 434 |
poll_s.events = POLLIN | POLLPRI; |
| 435 |
poll_s.revents = 0; |
| 436 |
|
| 437 |
DEBUG("Polling for %ims", timeout); |
| 438 |
status = poll(&poll_s, 1, timeout); |
| 439 |
|
| 440 |
if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR))) |
| 441 |
continue; |
| 442 |
|
| 443 |
if (status < 0) { |
| 444 |
ERROR("ntpd plugin: poll failed: %s", STRERRNO); |
| 445 |
return -1; |
| 446 |
} |
| 447 |
|
| 448 |
if (status == 0) /* timeout */ |
| 449 |
{ |
| 450 |
DEBUG("timeout reached."); |
| 451 |
break; |
| 452 |
} |
| 453 |
|
| 454 |
memset(&res, '\0', sizeof(res)); |
| 455 |
status = recv(sd, (void *)&res, sizeof(res), 0 /* no flags */); |
| 456 |
|
| 457 |
if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR))) |
| 458 |
continue; |
| 459 |
|
| 460 |
if (status < 0) { |
| 461 |
INFO("recv(2) failed: %s", STRERRNO); |
| 462 |
DEBUG("Closing socket #%i", sd); |
| 463 |
close(sd); |
| 464 |
sock_descr = sd = -1; |
| 465 |
return -1; |
| 466 |
} |
| 467 |
|
| 468 |
DEBUG("recv'd %i bytes", status); |
| 469 |
|
| 470 |
/* |
| 471 |
* Do some sanity checks first |
| 472 |
*/ |
| 473 |
if (status < RESP_HEADER_SIZE) { |
| 474 |
WARNING("ntpd plugin: Short (%i bytes) packet received", (int)status); |
| 475 |
continue; |
| 476 |
} |
| 477 |
if (INFO_MODE(res.rm_vn_mode) != MODE_PRIVATE) { |
| 478 |
NOTICE("ntpd plugin: Packet received with mode %i", |
| 479 |
INFO_MODE(res.rm_vn_mode)); |
| 480 |
continue; |
| 481 |
} |
| 482 |
if (INFO_IS_AUTH(res.auth_seq)) { |
| 483 |
NOTICE("ntpd plugin: Encrypted packet received"); |
| 484 |
continue; |
| 485 |
} |
| 486 |
if (!ISRESPONSE(res.rm_vn_mode)) { |
| 487 |
NOTICE("ntpd plugin: Received request packet, " |
| 488 |
"wanted response"); |
| 489 |
continue; |
| 490 |
} |
| 491 |
if (INFO_MBZ(res.mbz_itemsize)) { |
| 492 |
WARNING("ntpd plugin: Received packet with nonzero " |
| 493 |
"MBZ field!"); |
| 494 |
continue; |
| 495 |
} |
| 496 |
if (res.implementation != IMPL_XNTPD) { |
| 497 |
WARNING("ntpd plugin: Asked for request of type %i, " |
| 498 |
"got %i", |
| 499 |
(int)IMPL_XNTPD, (int)res.implementation); |
| 500 |
continue; |
| 501 |
} |
| 502 |
|
| 503 |
/* Check for error code */ |
| 504 |
if (INFO_ERR(res.err_nitems) != 0) { |
| 505 |
ERROR("ntpd plugin: Received error code %i", |
| 506 |
(int)INFO_ERR(res.err_nitems)); |
| 507 |
return (int)INFO_ERR(res.err_nitems); |
| 508 |
} |
| 509 |
|
| 510 |
/* extract number of items in this packet and the size of these items */ |
| 511 |
pkt_item_num = INFO_NITEMS(res.err_nitems); |
| 512 |
pkt_item_len = INFO_ITEMSIZE(res.mbz_itemsize); |
| 513 |
DEBUG("pkt_item_num = %i; pkt_item_len = %i;", pkt_item_num, pkt_item_len); |
| 514 |
|
| 515 |
/* Check if the reported items fit in the packet */ |
| 516 |
if ((pkt_item_num * pkt_item_len) > (status - RESP_HEADER_SIZE)) { |
| 517 |
ERROR("ntpd plugin: %i items * %i bytes > " |
| 518 |
"%i bytes - %i bytes header", |
| 519 |
(int)pkt_item_num, (int)pkt_item_len, (int)status, |
| 520 |
(int)RESP_HEADER_SIZE); |
| 521 |
continue; |
| 522 |
} |
| 523 |
|
| 524 |
if (pkt_item_len > res_item_size) { |
| 525 |
ERROR("ntpd plugin: (pkt_item_len = %i) " |
| 526 |
">= (res_item_size = %i)", |
| 527 |
pkt_item_len, res_item_size); |
| 528 |
continue; |
| 529 |
} |
| 530 |
|
| 531 |
/* If this is the first packet (time wise, not sequence wise), |
| 532 |
* set `res_size'. If it's not the first packet check if the |
| 533 |
* items have the same size. Discard invalid packets. */ |
| 534 |
if (items_num == 0) /* first packet */ |
| 535 |
{ |
| 536 |
DEBUG("*res_size = %i", pkt_item_len); |
| 537 |
*res_size = pkt_item_len; |
| 538 |
} else if (*res_size != pkt_item_len) { |
| 539 |
DEBUG("Error: *res_size = %i; pkt_item_len = %i;", *res_size, |
| 540 |
pkt_item_len); |
| 541 |
ERROR("Item sizes differ."); |
| 542 |
continue; |
| 543 |
} |
| 544 |
|
| 545 |
/* |
| 546 |
* Because the items in the packet may be smaller than the |
| 547 |
* items requested, the following holds true: |
| 548 |
*/ |
| 549 |
assert((*res_size == pkt_item_len) && (pkt_item_len <= res_item_size)); |
| 550 |
|
| 551 |
/* Calculate the padding. No idea why there might be any padding.. */ |
| 552 |
pkt_padding = 0; |
| 553 |
if (pkt_item_len < res_item_size) |
| 554 |
pkt_padding = res_item_size - pkt_item_len; |
| 555 |
DEBUG("res_item_size = %i; pkt_padding = %zi;", res_item_size, pkt_padding); |
| 556 |
|
| 557 |
/* Extract the sequence number */ |
| 558 |
pkt_sequence = INFO_SEQ(res.auth_seq); |
| 559 |
if ((pkt_sequence < 0) || (pkt_sequence > MAXSEQ)) { |
| 560 |
ERROR("ntpd plugin: Received packet with sequence %i", pkt_sequence); |
| 561 |
continue; |
| 562 |
} |
| 563 |
|
| 564 |
/* Check if this sequence has been received before. If so, discard it. */ |
| 565 |
if (pkt_recvd[pkt_sequence] != '\0') { |
| 566 |
NOTICE("ntpd plugin: Sequence %i received twice", pkt_sequence); |
| 567 |
continue; |
| 568 |
} |
| 569 |
|
| 570 |
/* If `pkt_lastseq != -1' another packet without `more bit' has |
| 571 |
* been received. */ |
| 572 |
if (!ISMORE(res.rm_vn_mode)) { |
| 573 |
if (pkt_lastseq != -1) { |
| 574 |
ERROR("ntpd plugin: Two packets which both " |
| 575 |
"claim to be the last one in the " |
| 576 |
"sequence have been received."); |
| 577 |
continue; |
| 578 |
} |
| 579 |
pkt_lastseq = pkt_sequence; |
| 580 |
DEBUG("Last sequence = %i;", pkt_lastseq); |
| 581 |
} |
| 582 |
|
| 583 |
/* |
| 584 |
* Enough with the checks. Copy the data now. |
| 585 |
* We start by allocating some more memory. |
| 586 |
*/ |
| 587 |
DEBUG("realloc (%p, %" PRIsz ")", (void *)*res_data, |
| 588 |
(items_num + pkt_item_num) * res_item_size); |
| 589 |
items = realloc(*res_data, (items_num + pkt_item_num) * res_item_size); |
| 590 |
if (items == NULL) { |
| 591 |
ERROR("ntpd plugin: realloc failed."); |
| 592 |
continue; |
| 593 |
} |
| 594 |
items_num += pkt_item_num; |
| 595 |
*res_data = items; |
| 596 |
|
| 597 |
for (int i = 0; i < pkt_item_num; i++) { |
| 598 |
/* dst: There are already `*res_items' items with |
| 599 |
* res_item_size bytes each in in `*res_data'. Set |
| 600 |
* dst to the first byte after that. */ |
| 601 |
void *dst = (void *)(*res_data + ((*res_items) * res_item_size)); |
| 602 |
/* src: We use `pkt_item_len' to calculate the offset |
| 603 |
* from the beginning of the packet, because the |
| 604 |
* items in the packet may be smaller than the |
| 605 |
* items that were requested. We skip `i' such |
| 606 |
* items. */ |
| 607 |
void *src = (void *)(((char *)res.data) + (i * pkt_item_len)); |
| 608 |
|
| 609 |
/* Set the padding to zeros */ |
| 610 |
if (pkt_padding != 0) |
| 611 |
memset(dst, '\0', res_item_size); |
| 612 |
memcpy(dst, src, (size_t)pkt_item_len); |
| 613 |
|
| 614 |
/* Increment `*res_items' by one, so `dst' will end up |
| 615 |
* one further in the next round. */ |
| 616 |
(*res_items)++; |
| 617 |
} /* for (pkt_item_num) */ |
| 618 |
|
| 619 |
pkt_recvd[pkt_sequence] = (char)1; |
| 620 |
pkt_recvd_num++; |
| 621 |
|
| 622 |
if ((pkt_recvd_num - 1) == pkt_lastseq) |
| 623 |
done = 1; |
| 624 |
} /* while (done == 0) */ |
| 625 |
|
| 626 |
return 0; |
| 627 |
} /* int ntpd_receive_response */ |
| 628 |
|
| 629 |
/* For a description of the arguments see `ntpd_do_query' below. */ |
| 630 |
static int ntpd_send_request(int req_code, int req_items, int req_size, |
| 631 |
char *req_data) { |
| 632 |
int sd; |
| 633 |
struct req_pkt req = {0}; |
| 634 |
size_t req_data_len; |
| 635 |
int status; |
| 636 |
|
| 637 |
assert(req_items >= 0); |
| 638 |
assert(req_size >= 0); |
| 639 |
|
| 640 |
if ((sd = ntpd_connect()) < 0) |
| 641 |
return -1; |
| 642 |
|
| 643 |
req.rm_vn_mode = RM_VN_MODE(0, 0, 0); |
| 644 |
req.auth_seq = AUTH_SEQ(0, 0); |
| 645 |
req.implementation = IMPL_XNTPD; |
| 646 |
req.request = (unsigned char)req_code; |
| 647 |
|
| 648 |
req_data_len = (size_t)(req_items * req_size); |
| 649 |
|
| 650 |
assert(((req_data != NULL) && (req_data_len > 0)) || |
| 651 |
((req_data == NULL) && (req_items == 0) && (req_size == 0))); |
| 652 |
|
| 653 |
req.err_nitems = ERR_NITEMS(0, req_items); |
| 654 |
req.mbz_itemsize = MBZ_ITEMSIZE(req_size); |
| 655 |
|
| 656 |
if (req_data != NULL) |
| 657 |
memcpy((void *)req.data, (const void *)req_data, req_data_len); |
| 658 |
|
| 659 |
DEBUG("req_items = %i; req_size = %i; req_data = %p;", req_items, req_size, |
| 660 |
(void *)req_data); |
| 661 |
|
| 662 |
status = swrite(sd, (const char *)&req, REQ_LEN_NOMAC); |
| 663 |
if (status != 0) { |
| 664 |
DEBUG("`swrite' failed. Closing socket #%i", sd); |
| 665 |
close(sd); |
| 666 |
sock_descr = sd = -1; |
| 667 |
return status; |
| 668 |
} |
| 669 |
|
| 670 |
return 0; |
| 671 |
} |
| 672 |
|
| 673 |
/* |
| 674 |
* ntpd_do_query: |
| 675 |
* |
| 676 |
* req_code: Type of request packet |
| 677 |
* req_items: Numver of items in the request |
| 678 |
* req_size: Size of one item in the request |
| 679 |
* req_data: Data of the request packet |
| 680 |
* res_items: Pointer to where the number returned items will be stored. |
| 681 |
* res_size: Pointer to where the size of one returned item will be stored. |
| 682 |
* res_data: This is where a pointer to the (allocated) data will be |
| 683 |
* stored. |
| 684 |
* res_item_size: Size of one returned item. (used to calculate padding) |
| 685 |
* |
| 686 |
* returns: zero upon success, non-zero otherwise. |
| 687 |
*/ |
| 688 |
static int ntpd_do_query(int req_code, int req_items, int req_size, |
| 689 |
char *req_data, int *res_items, int *res_size, |
| 690 |
char **res_data, int res_item_size) { |
| 691 |
int status; |
| 692 |
|
| 693 |
status = ntpd_send_request(req_code, req_items, req_size, req_data); |
| 694 |
if (status != 0) |
| 695 |
return status; |
| 696 |
|
| 697 |
status = ntpd_receive_response(res_items, res_size, res_data, res_item_size); |
| 698 |
return status; |
| 699 |
} |
| 700 |
|
| 701 |
static double ntpd_read_fp(int32_t val_int) { |
| 702 |
double val_double; |
| 703 |
|
| 704 |
val_int = ntohl(val_int); |
| 705 |
val_double = ((double)val_int) / FP_FRAC; |
| 706 |
|
| 707 |
return val_double; |
| 708 |
} |
| 709 |
|
| 710 |
static uint32_t |
| 711 |
ntpd_get_refclock_id(struct info_peer_summary const *peer_info) { |
| 712 |
uint32_t addr = ntohl(peer_info->srcadr); |
| 713 |
uint32_t refclock_id = (addr >> 8) & 0x00FF; |
| 714 |
|
| 715 |
return refclock_id; |
| 716 |
} |
| 717 |
|
| 718 |
static int ntpd_get_name_from_address(char *buffer, size_t buffer_size, |
| 719 |
struct info_peer_summary const *peer_info, |
| 720 |
bool do_reverse_lookup) { |
| 721 |
struct sockaddr_storage sa = {0}; |
| 722 |
socklen_t sa_len; |
| 723 |
int flags = 0; |
| 724 |
int status; |
| 725 |
|
| 726 |
if (peer_info->v6_flag) { |
| 727 |
struct sockaddr_in6 sa6 = {0}; |
| 728 |
|
| 729 |
assert(sizeof(sa) >= sizeof(sa6)); |
| 730 |
|
| 731 |
sa6.sin6_family = AF_INET6; |
| 732 |
sa6.sin6_port = htons(123); |
| 733 |
memcpy(&sa6.sin6_addr, &peer_info->srcadr6, sizeof(struct in6_addr)); |
| 734 |
sa_len = sizeof(sa6); |
| 735 |
|
| 736 |
memcpy(&sa, &sa6, sizeof(sa6)); |
| 737 |
} else { |
| 738 |
struct sockaddr_in sa4 = {0}; |
| 739 |
|
| 740 |
assert(sizeof(sa) >= sizeof(sa4)); |
| 741 |
|
| 742 |
sa4.sin_family = AF_INET; |
| 743 |
sa4.sin_port = htons(123); |
| 744 |
memcpy(&sa4.sin_addr, &peer_info->srcadr, sizeof(struct in_addr)); |
| 745 |
sa_len = sizeof(sa4); |
| 746 |
|
| 747 |
memcpy(&sa, &sa4, sizeof(sa4)); |
| 748 |
} |
| 749 |
|
| 750 |
if (!do_reverse_lookup) |
| 751 |
flags |= NI_NUMERICHOST; |
| 752 |
|
| 753 |
status = getnameinfo((struct sockaddr const *)&sa, sa_len, buffer, |
| 754 |
buffer_size, NULL, 0, /* No port name */ |
| 755 |
flags); |
| 756 |
if (status != 0) { |
| 757 |
ERROR("ntpd plugin: getnameinfo failed: %s", |
| 758 |
(status == EAI_SYSTEM) ? STRERRNO : gai_strerror(status)); |
| 759 |
return -1; |
| 760 |
} |
| 761 |
|
| 762 |
return 0; |
| 763 |
} /* ntpd_get_name_from_address */ |
| 764 |
|
| 765 |
static int ntpd_get_name_refclock(char *buffer, size_t buffer_size, |
| 766 |
struct info_peer_summary const *peer_info) { |
| 767 |
uint32_t refclock_id = ntpd_get_refclock_id(peer_info); |
| 768 |
uint32_t unit_id = ntohl(peer_info->srcadr) & 0x00FF; |
| 769 |
|
| 770 |
if (((size_t)refclock_id) >= refclock_names_num) |
| 771 |
return ntpd_get_name_from_address(buffer, buffer_size, peer_info, 0); |
| 772 |
|
| 773 |
if (include_unit_id) |
| 774 |
snprintf(buffer, buffer_size, "%s-%" PRIu32, refclock_names[refclock_id], |
| 775 |
unit_id); |
| 776 |
else |
| 777 |
sstrncpy(buffer, refclock_names[refclock_id], buffer_size); |
| 778 |
|
| 779 |
return 0; |
| 780 |
} /* int ntpd_get_name_refclock */ |
| 781 |
|
| 782 |
static int ntpd_read(void) { |
| 783 |
struct info_kernel *ik; |
| 784 |
int ik_num; |
| 785 |
int ik_size; |
| 786 |
|
| 787 |
struct info_peer_summary *ps; |
| 788 |
int ps_num; |
| 789 |
int ps_size; |
| 790 |
|
| 791 |
gauge_t offset_loop; |
| 792 |
gauge_t freq_loop; |
| 793 |
gauge_t offset_error; |
| 794 |
|
| 795 |
int status; |
| 796 |
|
| 797 |
/* On Linux, if the STA_NANO bit is set in ik->status, then ik->offset |
| 798 |
* is is nanoseconds, otherwise it's microseconds. */ |
| 799 |
double scale_loop = 1e-6; |
| 800 |
double scale_error = 1e-6; |
| 801 |
|
| 802 |
ik = NULL; |
| 803 |
ik_num = 0; |
| 804 |
ik_size = 0; |
| 805 |
|
| 806 |
status = ntpd_do_query(REQ_GET_KERNEL, 0, 0, NULL, /* request data */ |
| 807 |
&ik_num, &ik_size, |
| 808 |
(char **)((void *)&ik), /* response data */ |
| 809 |
sizeof(struct info_kernel)); |
| 810 |
if (status != 0) { |
| 811 |
ERROR("ntpd plugin: ntpd_do_query (REQ_GET_KERNEL) failed with status %i", |
| 812 |
status); |
| 813 |
free(ik); |
| 814 |
return status; |
| 815 |
} else if ((ik == NULL) || (ik_num == 0) || (ik_size == 0)) { |
| 816 |
ERROR("ntpd plugin: ntpd_do_query returned unexpected data. " |
| 817 |
"(ik = %p; ik_num = %i; ik_size = %i)", |
| 818 |
(void *)ik, ik_num, ik_size); |
| 819 |
free(ik); |
| 820 |
return -1; |
| 821 |
} |
| 822 |
|
| 823 |
if (ntohs(ik->status) & STA_NANO) { |
| 824 |
scale_loop = 1e-9; |
| 825 |
scale_error = 1e-9; |
| 826 |
} |
| 827 |
|
| 828 |
/* kerninfo -> estimated error */ |
| 829 |
offset_loop = (gauge_t)((int32_t)ntohl(ik->offset) * scale_loop); |
| 830 |
freq_loop = ntpd_read_fp(ik->freq); |
| 831 |
offset_error = (gauge_t)((int32_t)ntohl(ik->esterror) * scale_error); |
| 832 |
|
| 833 |
DEBUG("info_kernel:\n" |
| 834 |
" pll offset = %.8g\n" |
| 835 |
" pll frequency = %.8g\n" /* drift compensation */ |
| 836 |
" est error = %.8g\n", |
| 837 |
offset_loop, freq_loop, offset_error); |
| 838 |
|
| 839 |
ntpd_submit("frequency_offset", "loop", freq_loop); |
| 840 |
ntpd_submit("time_offset", "loop", offset_loop); |
| 841 |
ntpd_submit("time_offset", "error", offset_error); |
| 842 |
|
| 843 |
free(ik); |
| 844 |
ik = NULL; |
| 845 |
|
| 846 |
status = ntpd_do_query(REQ_PEER_LIST_SUM, 0, 0, NULL, /* request data */ |
| 847 |
&ps_num, &ps_size, |
| 848 |
(char **)((void *)&ps), /* response data */ |
| 849 |
sizeof(struct info_peer_summary)); |
| 850 |
if (status != 0) { |
| 851 |
ERROR( |
| 852 |
"ntpd plugin: ntpd_do_query (REQ_PEER_LIST_SUM) failed with status %i", |
| 853 |
status); |
| 854 |
free(ps); |
| 855 |
return status; |
| 856 |
} else if ((ps == NULL) || (ps_num == 0) || (ps_size == 0)) { |
| 857 |
ERROR("ntpd plugin: ntpd_do_query returned unexpected data. " |
| 858 |
"(ps = %p; ps_num = %i; ps_size = %i)", |
| 859 |
(void *)ps, ps_num, ps_size); |
| 860 |
free(ps); |
| 861 |
return -1; |
| 862 |
} |
| 863 |
|
| 864 |
for (int i = 0; i < ps_num; i++) { |
| 865 |
struct info_peer_summary *ptr; |
| 866 |
double offset; |
| 867 |
|
| 868 |
char peername[NI_MAXHOST]; |
| 869 |
uint32_t refclock_id; |
| 870 |
|
| 871 |
ptr = ps + i; |
| 872 |
|
| 873 |
int is_refclock = !ptr->v6_flag && |
| 874 |
((ntohl(ptr->srcadr) & REFCLOCK_MASK) == REFCLOCK_ADDR); |
| 875 |
|
| 876 |
if (is_refclock) |
| 877 |
status = ntpd_get_name_refclock(peername, sizeof(peername), ptr); |
| 878 |
else |
| 879 |
status = ntpd_get_name_from_address(peername, sizeof(peername), ptr, |
| 880 |
do_reverse_lookups); |
| 881 |
|
| 882 |
if (status != 0) { |
| 883 |
ERROR("ntpd plugin: Determining name of peer failed."); |
| 884 |
continue; |
| 885 |
} |
| 886 |
|
| 887 |
// `0.0.0.0` hosts are caused by POOL servers |
| 888 |
// see https://github.com/collectd/collectd/issues/2358 |
| 889 |
if (strcmp(peername, "0.0.0.0") == 0) { |
| 890 |
continue; |
| 891 |
} |
| 892 |
|
| 893 |
refclock_id = ntpd_get_refclock_id(ptr); |
| 894 |
|
| 895 |
/* Convert the `long floating point' offset value to double */ |
| 896 |
M_LFPTOD(ntohl(ptr->offset_int), ntohl(ptr->offset_frc), offset); |
| 897 |
|
| 898 |
DEBUG("peer %i:\n" |
| 899 |
" is_refclock= %d\n" |
| 900 |
" refclock_id= %d\n" |
| 901 |
" peername = %s\n" |
| 902 |
" srcadr = 0x%08x\n" |
| 903 |
" reach = 0%03o\n" |
| 904 |
" delay = %f\n" |
| 905 |
" offset_int = %i\n" |
| 906 |
" offset_frc = %i\n" |
| 907 |
" offset = %f\n" |
| 908 |
" dispersion = %f\n", |
| 909 |
i, is_refclock, (is_refclock > 0) ? refclock_id : 0, peername, |
| 910 |
ntohl(ptr->srcadr), ptr->reach, ntpd_read_fp(ptr->delay), |
| 911 |
ntohl(ptr->offset_int), ntohl(ptr->offset_frc), offset, |
| 912 |
ntpd_read_fp(ptr->dispersion)); |
| 913 |
|
| 914 |
ntpd_submit_reach("time_dispersion", peername, ptr->reach, |
| 915 |
ntpd_read_fp(ptr->dispersion)); |
| 916 |
|
| 917 |
/* not the system clock (offset will always be zero) */ |
| 918 |
if (!(is_refclock && refclock_id == 1)) |
| 919 |
ntpd_submit_reach("time_offset", peername, ptr->reach, offset); |
| 920 |
|
| 921 |
if (!is_refclock) /* not a reference clock */ |
| 922 |
ntpd_submit_reach("delay", peername, ptr->reach, |
| 923 |
ntpd_read_fp(ptr->delay)); |
| 924 |
} |
| 925 |
|
| 926 |
free(ps); |
| 927 |
ps = NULL; |
| 928 |
|
| 929 |
return 0; |
| 930 |
} /* int ntpd_read */ |
| 931 |
|
| 932 |
void module_register(void) { |
| 933 |
plugin_register_config("ntpd", ntpd_config, config_keys, config_keys_num); |
| 934 |
plugin_register_read("ntpd", ntpd_read); |
| 935 |
} /* void module_register */ |