src/ntpd.c

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