src/chrony.c

   1 /* chrony plugin for collectd (monitoring of chrony time server daemon)
   2  **********************************************************************
   3  * Copyright (C) Claudius M Zingerli, ZSeng, 2015-2016
   4  *
   5  * Internals roughly based on the ntpd plugin
   6  * Some functions copied from chronyd/web (as marked)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of version 2 of the GNU General Public License as
  10  * published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20  *
  21  * TODO:
  22  *      - More robust udp parsing (using offsets instead of structs?)
  23  *        -> Currently chrony parses its data the same way as we do (using
  24  *structs)
  25  *      - Plausibility checks on values received
  26  *        -> Done at higher levels
  27  */
  28
  29 #include "collectd.h"
  30
  31 #include "common.h" /* auxiliary functions */
  32 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
  33
  34 #if HAVE_NETDB_H
  35 #include <netdb.h> /* struct addrinfo */
  36 #endif
  37 #if HAVE_ARPA_INET_H
  38 #include <arpa/inet.h> /* ntohs/ntohl */
  39 #endif
  40
  41 #define CONFIG_KEY_HOST "Host"
  42 #define CONFIG_KEY_PORT "Port"
  43 #define CONFIG_KEY_TIMEOUT "Timeout"
  44
  45 #define URAND_DEVICE_PATH                                                      \
  46   "/dev/urandom" /* Used to initialize seq nr generator */
  47 #define RAND_DEVICE_PATH                                                       \
  48   "/dev/random" /* Used to initialize seq nr generator (fall back) */
  49
  50 static const char *g_config_keys[] = {CONFIG_KEY_HOST, CONFIG_KEY_PORT,
  51                                       CONFIG_KEY_TIMEOUT};
  52
  53 static int g_config_keys_num = STATIC_ARRAY_SIZE(g_config_keys);
  54 static int g_chrony_is_connected;
  55 static int g_chrony_socket = -1;
  56 static time_t g_chrony_timeout = -1;
  57 static char *g_chrony_plugin_instance;
  58 static char *g_chrony_host;
  59 static char *g_chrony_port;
  60 static uint32_t g_chrony_rand = 1;
  61 static uint32_t g_chrony_seq_is_initialized;
  62
  63 #define PLUGIN_NAME_SHORT "chrony"
  64 #define PLUGIN_NAME PLUGIN_NAME_SHORT " plugin"
  65 #define DAEMON_NAME PLUGIN_NAME_SHORT
  66 #define CHRONY_DEFAULT_HOST "localhost"
  67 #define CHRONY_DEFAULT_PORT "323"
  68 #define CHRONY_DEFAULT_TIMEOUT 2
  69
  70 /* Return codes (collectd expects non-zero on errors) */
  71 #define CHRONY_RC_OK 0
  72 #define CHRONY_RC_FAIL 1
  73
  74 /* Chronyd command packet variables adapted from chrony/candm.h (GPL2) */
  75 #define PROTO_VERSION_NUMBER 6
  76 #define IPADDR_UNSPEC 0
  77 #define IPADDR_INET4 1
  78 #define IPADDR_INET6 2
  79 #define IPV6_STR_MAX_SIZE (8 * 4 + 7 + 1)
  80
  81 typedef enum { PKT_TYPE_CMD_REQUEST = 1, PKT_TYPE_CMD_REPLY = 2 } ePacketType;
  82
  83 typedef enum {
  84   REQ_N_SOURCES = 14,
  85   REQ_SOURCE_DATA = 15,
  86   REQ_TRACKING = 33,
  87   REQ_SOURCE_STATS = 34
  88 } eDaemonRequests;
  89
  90 typedef enum {
  91   RPY_NULL = 1,
  92   RPY_N_SOURCES = 2,
  93   RPY_SOURCE_DATA = 3,
  94   RPY_MANUAL_TIMESTAMP = 4,
  95   RPY_TRACKING = 5,
  96   RPY_SOURCE_STATS = 6,
  97   RPY_RTC = 7
  98 } eDaemonReplies;
  99
 100 #if defined(__GNUC__) || defined(__SUNPRO_C) || defined(lint)
 101 #/* extension to enforce struct packing. */
 102 #define ATTRIB_PACKED __attribute__((packed))
 103 #else
 104 #error Not defining packed attribute (unknown compiler)
 105 #define ATTRIB_PACKED
 106 #endif
 107
 108 typedef struct ATTRIB_PACKED { int32_t value; } tFloat;
 109
 110 typedef struct ATTRIB_PACKED {
 111   uint32_t tv_sec_high;
 112   uint32_t tv_sec_low;
 113   uint32_t tv_nsec;
 114 } tTimeval;
 115
 116 typedef enum {
 117   STT_SUCCESS = 0,
 118   STT_FAILED = 1,
 119   STT_UNAUTH = 2,
 120   STT_INVALID = 3,
 121   STT_NOSUCHSOURCE = 4,
 122   STT_INVALIDTS = 5,
 123   STT_NOTENABLED = 6,
 124   STT_BADSUBNET = 7,
 125   STT_ACCESSALLOWED = 8,
 126   STT_ACCESSDENIED = 9,
 127   STT_NOHOSTACCESS = 10,
 128   STT_SOURCEALREADYKNOWN = 11,
 129   STT_TOOMANYSOURCES = 12,
 130   STT_NORTC = 13,
 131   STT_BADRTCFILE = 14,
 132   STT_INACTIVE = 15,
 133   STT_BADSAMPLE = 16,
 134   STT_INVALIDAF = 17,
 135   STT_BADPKTVERSION = 18,
 136   STT_BADPKTLENGTH = 19
 137 } eChrony_Status;
 138
 139 /* Chrony client request packets */
 140 typedef struct ATTRIB_PACKED {
 141   uint8_t f_dummy0[80]; /* Chrony expects 80bytes dummy data (Avoiding UDP
 142                            Amplification) */
 143 } tChrony_Req_Tracking;
 144
 145 typedef struct ATTRIB_PACKED { uint32_t f_n_sources; } tChrony_Req_N_Sources;
 146
 147 typedef struct ATTRIB_PACKED {
 148   int32_t f_index;
 149   uint8_t f_dummy0[44];
 150 } tChrony_Req_Source_data;
 151
 152 typedef struct ATTRIB_PACKED {
 153   int32_t f_index;
 154   uint8_t f_dummy0[56];
 155 } tChrony_Req_Source_stats;
 156
 157 typedef struct ATTRIB_PACKED {
 158   struct {
 159     uint8_t f_version;
 160     uint8_t f_type;
 161     uint8_t f_dummy0;
 162     uint8_t f_dummy1;
 163     uint16_t f_cmd;
 164     uint16_t f_cmd_try;
 165     uint32_t f_seq;
 166
 167     uint32_t f_dummy2;
 168     uint32_t f_dummy3;
 169   } header; /* Packed: 20Bytes */
 170   union {
 171     tChrony_Req_N_Sources n_sources;
 172     tChrony_Req_Source_data source_data;
 173     tChrony_Req_Source_stats source_stats;
 174     tChrony_Req_Tracking tracking;
 175   } body;
 176   uint8_t padding[4 + 16]; /* Padding to match minimal response size */
 177 } tChrony_Request;
 178
 179 /* Chrony daemon response packets */
 180 typedef struct ATTRIB_PACKED { uint32_t f_n_sources; } tChrony_Resp_N_Sources;
 181
 182 typedef struct ATTRIB_PACKED {
 183   union {
 184     uint32_t ip4;
 185     uint8_t ip6[16];
 186   } addr;
 187   uint16_t f_family;
 188 } tChrony_IPAddr;
 189
 190 typedef struct ATTRIB_PACKED {
 191   tChrony_IPAddr addr;
 192   uint16_t
 193       dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
 194                 x86_64 */
 195   int16_t f_poll;     /* 2^f_poll = Time between polls (s) */
 196   uint16_t f_stratum; /* Remote clock stratum */
 197   uint16_t f_state;   /* 0 = RPY_SD_ST_SYNC,    1 = RPY_SD_ST_UNREACH,   2 =
 198                          RPY_SD_ST_FALSETICKER */
 199   /* 3 = RPY_SD_ST_JITTERY, 4 = RPY_SD_ST_CANDIDATE, 5 = RPY_SD_ST_OUTLIER */
 200   uint16_t f_mode;  /* 0 = RPY_SD_MD_CLIENT,  1 = RPY_SD_MD_PEER,      2 =
 201                        RPY_SD_MD_REF         */
 202   uint16_t f_flags; /* unused */
 203   uint16_t
 204       f_reachability; /* Bit mask of successfull tries to reach the source */
 205
 206   uint32_t f_since_sample;     /* Time since last sample (s) */
 207   tFloat f_origin_latest_meas; /*  */
 208   tFloat f_latest_meas;        /*  */
 209   tFloat f_latest_meas_err;    /*  */
 210 } tChrony_Resp_Source_data;
 211
 212 typedef struct ATTRIB_PACKED {
 213   uint32_t f_ref_id;
 214   tChrony_IPAddr addr;
 215   uint16_t
 216       dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
 217                 x86_64 */
 218   uint32_t f_n_samples;       /* Number of measurements done   */
 219   uint32_t f_n_runs;          /* How many measurements to come */
 220   uint32_t f_span_seconds;    /* For how long we're measuring  */
 221   tFloat f_rtc_seconds_fast;  /* ??? */
 222   tFloat f_rtc_gain_rate_ppm; /* Estimated relative frequency error */
 223   tFloat f_skew_ppm;       /* Clock skew (ppm) (worst case freq est error (skew:
 224                               peak2peak)) */
 225   tFloat f_est_offset;     /* Estimated offset of source */
 226   tFloat f_est_offset_err; /* Error of estimation        */
 227 } tChrony_Resp_Source_stats;
 228
 229 typedef struct ATTRIB_PACKED {
 230   uint32_t f_ref_id;
 231   tChrony_IPAddr addr;
 232   uint16_t
 233       dummy; /* FIXME: Strange dummy space. Needed on gcc 4.8.3/clang 3.4.1 on
 234                 x86_64 */
 235   uint16_t f_stratum;
 236   uint16_t f_leap_status;
 237   tTimeval f_ref_time;
 238   tFloat f_current_correction;
 239   tFloat f_last_offset;
 240   tFloat f_rms_offset;
 241   tFloat f_freq_ppm;
 242   tFloat f_resid_freq_ppm;
 243   tFloat f_skew_ppm;
 244   tFloat f_root_delay;
 245   tFloat f_root_dispersion;
 246   tFloat f_last_update_interval;
 247 } tChrony_Resp_Tracking;
 248
 249 typedef struct ATTRIB_PACKED {
 250   struct {
 251     uint8_t f_version;
 252     uint8_t f_type;
 253     uint8_t f_dummy0;
 254     uint8_t f_dummy1;
 255     uint16_t f_cmd;
 256     uint16_t f_reply;
 257     uint16_t f_status;
 258     uint16_t f_dummy2;
 259     uint16_t f_dummy3;
 260     uint16_t f_dummy4;
 261     uint32_t f_seq;
 262     uint32_t f_dummy5;
 263     uint32_t f_dummy6;
 264   } header; /* Packed: 28 Bytes */
 265
 266   union {
 267     tChrony_Resp_N_Sources n_sources;
 268     tChrony_Resp_Source_data source_data;
 269     tChrony_Resp_Source_stats source_stats;
 270     tChrony_Resp_Tracking tracking;
 271   } body;
 272
 273   uint8_t padding[1024];
 274 } tChrony_Response;
 275
 276 /*****************************************************************************/
 277 /* Internal functions */
 278 /*****************************************************************************/
 279
 280 /* connect_client code adapted from:
 281  * http://long.ccaba.upc.edu/long/045Guidelines/eva/ipv6.html#daytimeClient6 */
 282 /* License granted by Eva M Castro via e-mail on 2016-02-18 under the terms of
 283  * GPLv3 */
 284 static int connect_client(const char *p_hostname, const char *p_service,
 285                           int p_family, int p_socktype) {
 286   struct addrinfo *res, *ressave;
 287   int n, sockfd;
 288
 289   struct addrinfo ai_hints = {.ai_family = p_family, .ai_socktype = p_socktype};
 290
 291   n = getaddrinfo(p_hostname, p_service, &ai_hints, &res);
 292
 293   if (n < 0) {
 294     ERROR(PLUGIN_NAME ": getaddrinfo error:: [%s]", gai_strerror(n));
 295     return -1;
 296   }
 297
 298   ressave = res;
 299
 300   sockfd = -1;
 301   while (res) {
 302     sockfd = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
 303
 304     if (!(sockfd < 0)) {
 305       if (connect(sockfd, res->ai_addr, res->ai_addrlen) == 0) {
 306         /* Success */
 307         break;
 308       }
 309
 310       close(sockfd);
 311       sockfd = -1;
 312     }
 313     res = res->ai_next;
 314   }
 315
 316   freeaddrinfo(ressave);
 317   return sockfd;
 318 }
 319
 320 /* niptoha code originally from:
 321  * git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
 322 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
 323 /* Original name: char * UTI_IPToString(IPAddr *addr)*/
 324 static char *niptoha(const tChrony_IPAddr *addr, char *p_buf,
 325                      size_t p_buf_size) {
 326   int rc = 1;
 327   unsigned long a, b, c, d, ip;
 328
 329   switch (ntohs(addr->f_family)) {
 330   case IPADDR_UNSPEC:
 331     rc = snprintf(p_buf, p_buf_size, "[UNSPEC]");
 332     break;
 333   case IPADDR_INET4:
 334     ip = ntohl(addr->addr.ip4);
 335     a = (ip >> 24) & 0xff;
 336     b = (ip >> 16) & 0xff;
 337     c = (ip >> 8) & 0xff;
 338     d = (ip >> 0) & 0xff;
 339     rc = snprintf(p_buf, p_buf_size, "%ld.%ld.%ld.%ld", a, b, c, d);
 340     break;
 341   case IPADDR_INET6: {
 342     const char *rp = inet_ntop(AF_INET6, addr->addr.ip6, p_buf, p_buf_size);
 343     if (rp == NULL) {
 344       ERROR(PLUGIN_NAME ": Error converting ipv6 address to string. Errno = %d",
 345             errno);
 346       rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
 347     }
 348     break;
 349   }
 350   default:
 351     rc = snprintf(p_buf, p_buf_size, "[UNKNOWN]");
 352   }
 353   assert(rc > 0);
 354   return p_buf;
 355 }
 356
 357 static int chrony_set_timeout(void) {
 358   /* Set the socket's  timeout to g_chrony_timeout; a value of 0 signals
 359    * infinite timeout */
 360   /* Returns 0 on success, !0 on error (check errno) */
 361
 362   struct timeval tv;
 363   tv.tv_sec = g_chrony_timeout;
 364   tv.tv_usec = 0;
 365
 366   assert(g_chrony_socket >= 0);
 367   if (setsockopt(g_chrony_socket, SOL_SOCKET, SO_RCVTIMEO, (char *)&tv,
 368                  sizeof(struct timeval)) < 0) {
 369     return CHRONY_RC_FAIL;
 370   }
 371   return CHRONY_RC_OK;
 372 }
 373
 374 static int chrony_connect(void) {
 375   /* Connects to the chrony daemon */
 376   /* Returns 0 on success, !0 on error (check errno) */
 377   int socket;
 378
 379   if (g_chrony_host == NULL) {
 380     g_chrony_host = strdup(CHRONY_DEFAULT_HOST);
 381     if (g_chrony_host == NULL) {
 382       ERROR(PLUGIN_NAME ": Error duplicating chrony host name");
 383       return CHRONY_RC_FAIL;
 384     }
 385   }
 386   if (g_chrony_port == NULL) {
 387     g_chrony_port = strdup(CHRONY_DEFAULT_PORT);
 388     if (g_chrony_port == NULL) {
 389       ERROR(PLUGIN_NAME ": Error duplicating chrony port string");
 390       return CHRONY_RC_FAIL;
 391     }
 392   }
 393   if (g_chrony_timeout < 0) {
 394     g_chrony_timeout = CHRONY_DEFAULT_TIMEOUT;
 395     assert(g_chrony_timeout >= 0);
 396   }
 397
 398   DEBUG(PLUGIN_NAME ": Connecting to %s:%s", g_chrony_host, g_chrony_port);
 399   socket = connect_client(g_chrony_host, g_chrony_port, AF_UNSPEC, SOCK_DGRAM);
 400   if (socket < 0) {
 401     ERROR(PLUGIN_NAME ": Error connecting to daemon. Errno = %d", errno);
 402     return CHRONY_RC_FAIL;
 403   }
 404   DEBUG(PLUGIN_NAME ": Connected");
 405   g_chrony_socket = socket;
 406
 407   if (chrony_set_timeout()) {
 408     ERROR(PLUGIN_NAME ": Error setting timeout to %llds. Errno = %d",
 409           (long long)g_chrony_timeout, errno);
 410     return CHRONY_RC_FAIL;
 411   }
 412   return CHRONY_RC_OK;
 413 }
 414
 415 static int chrony_send_request(const tChrony_Request *p_req,
 416                                size_t p_req_size) {
 417   if (send(g_chrony_socket, p_req, p_req_size, 0) < 0) {
 418     ERROR(PLUGIN_NAME ": Error sending packet. Errno = %d", errno);
 419     return CHRONY_RC_FAIL;
 420   }
 421   return CHRONY_RC_OK;
 422 }
 423
 424 static int chrony_recv_response(tChrony_Response *p_resp,
 425                                 size_t p_resp_max_size, size_t *p_resp_size) {
 426   ssize_t rc = recv(g_chrony_socket, p_resp, p_resp_max_size, 0);
 427   if (rc <= 0) {
 428     ERROR(PLUGIN_NAME ": Error receiving packet: %s (%d)", strerror(errno),
 429           errno);
 430     return CHRONY_RC_FAIL;
 431   } else {
 432     *p_resp_size = rc;
 433     return CHRONY_RC_OK;
 434   }
 435 }
 436
 437 static int chrony_query(const int p_command, tChrony_Request *p_req,
 438                         tChrony_Response *p_resp, size_t *p_resp_size) {
 439   /* Check connection. We simply perform one try as collectd already handles
 440    * retries */
 441   assert(p_req);
 442   assert(p_resp);
 443   assert(p_resp_size);
 444
 445   if (g_chrony_is_connected == 0) {
 446     if (chrony_connect() == CHRONY_RC_OK) {
 447       g_chrony_is_connected = 1;
 448     } else {
 449       ERROR(PLUGIN_NAME ": Unable to connect. Errno = %d", errno);
 450       return CHRONY_RC_FAIL;
 451     }
 452   }
 453
 454   do {
 455     int valid_command = 0;
 456     size_t req_size = sizeof(p_req->header) + sizeof(p_req->padding);
 457     size_t resp_size = sizeof(p_resp->header);
 458     uint16_t resp_code = RPY_NULL;
 459     switch (p_command) {
 460     case REQ_TRACKING:
 461       req_size += sizeof(p_req->body.tracking);
 462       resp_size += sizeof(p_resp->body.tracking);
 463       resp_code = RPY_TRACKING;
 464       valid_command = 1;
 465       break;
 466     case REQ_N_SOURCES:
 467       req_size += sizeof(p_req->body.n_sources);
 468       resp_size += sizeof(p_resp->body.n_sources);
 469       resp_code = RPY_N_SOURCES;
 470       valid_command = 1;
 471       break;
 472     case REQ_SOURCE_DATA:
 473       req_size += sizeof(p_req->body.source_data);
 474       resp_size += sizeof(p_resp->body.source_data);
 475       resp_code = RPY_SOURCE_DATA;
 476       valid_command = 1;
 477       break;
 478     case REQ_SOURCE_STATS:
 479       req_size += sizeof(p_req->body.source_stats);
 480       resp_size += sizeof(p_resp->body.source_stats);
 481       resp_code = RPY_SOURCE_STATS;
 482       valid_command = 1;
 483       break;
 484     default:
 485       ERROR(PLUGIN_NAME ": Unknown request command (Was: %d)", p_command);
 486       break;
 487     }
 488
 489     if (valid_command == 0)
 490       break;
 491
 492     uint32_t seq_nr = rand_r(&g_chrony_rand);
 493     p_req->header.f_cmd = htons(p_command);
 494     p_req->header.f_cmd_try = 0;
 495     p_req->header.f_seq = seq_nr;
 496
 497     DEBUG(PLUGIN_NAME ": Sending request (.cmd = %d, .seq = %d)", p_command,
 498           seq_nr);
 499     if (chrony_send_request(p_req, req_size) != 0)
 500       break;
 501
 502     DEBUG(PLUGIN_NAME ": Waiting for response");
 503     if (chrony_recv_response(p_resp, resp_size, p_resp_size) != 0)
 504       break;
 505
 506     DEBUG(PLUGIN_NAME ": Received response: .version = %u, .type = %u, .cmd = "
 507                       "%u, .reply = %u, .status = %u, .seq = %u",
 508           p_resp->header.f_version, p_resp->header.f_type,
 509           ntohs(p_resp->header.f_cmd), ntohs(p_resp->header.f_reply),
 510           ntohs(p_resp->header.f_status), p_resp->header.f_seq);
 511
 512     if (p_resp->header.f_version != p_req->header.f_version) {
 513       ERROR(PLUGIN_NAME ": Wrong protocol version (Was: %d, expected: %d)",
 514             p_resp->header.f_version, p_req->header.f_version);
 515       return CHRONY_RC_FAIL;
 516     }
 517     if (p_resp->header.f_type != PKT_TYPE_CMD_REPLY) {
 518       ERROR(PLUGIN_NAME ": Wrong packet type (Was: %d, expected: %d)",
 519             p_resp->header.f_type, PKT_TYPE_CMD_REPLY);
 520       return CHRONY_RC_FAIL;
 521     }
 522     if (p_resp->header.f_seq != seq_nr) {
 523       /* FIXME: Implement sequence number handling */
 524       ERROR(PLUGIN_NAME ": Unexpected sequence number (Was: %d, expected: %d)",
 525             p_resp->header.f_seq, p_req->header.f_seq);
 526       return CHRONY_RC_FAIL;
 527     }
 528     if (p_resp->header.f_cmd != p_req->header.f_cmd) {
 529       ERROR(PLUGIN_NAME ": Wrong reply command (Was: %d, expected: %d)",
 530             p_resp->header.f_cmd, p_req->header.f_cmd);
 531       return CHRONY_RC_FAIL;
 532     }
 533
 534     if (ntohs(p_resp->header.f_reply) != resp_code) {
 535       ERROR(PLUGIN_NAME ": Wrong reply code (Was: %d, expected: %d)",
 536             ntohs(p_resp->header.f_reply), resp_code);
 537       return CHRONY_RC_FAIL;
 538     }
 539
 540     switch (p_resp->header.f_status) {
 541     case STT_SUCCESS:
 542       DEBUG(PLUGIN_NAME ": Reply packet status STT_SUCCESS");
 543       break;
 544     default:
 545       ERROR(PLUGIN_NAME
 546             ": Reply packet contains error status: %d (expected: %d)",
 547             p_resp->header.f_status, STT_SUCCESS);
 548       return CHRONY_RC_FAIL;
 549     }
 550
 551     /* Good result */
 552     return CHRONY_RC_OK;
 553   } while (0);
 554
 555   /* Some error occured */
 556   return CHRONY_RC_FAIL;
 557 }
 558
 559 static void chrony_init_req(tChrony_Request *p_req) {
 560   memset(p_req, 0, sizeof(*p_req));
 561   p_req->header.f_version = PROTO_VERSION_NUMBER;
 562   p_req->header.f_type = PKT_TYPE_CMD_REQUEST;
 563   p_req->header.f_dummy0 = 0;
 564   p_req->header.f_dummy1 = 0;
 565   p_req->header.f_dummy2 = 0;
 566   p_req->header.f_dummy3 = 0;
 567 }
 568
 569 /* ntohf code originally from:
 570  * git://git.tuxfamily.org/gitroot/chrony/chrony.git:util.c */
 571 /* Original code licensed as GPLv2, by Richard P. Purnow, Miroslav Lichvar */
 572 /* Original name: double UTI_tFloatNetworkToHost(tFloat f) */
 573 static double ntohf(tFloat p_float) {
 574 /* Convert tFloat in Network-bit-order to double in host-bit-order */
 575
 576 #define FLOAT_EXP_BITS 7
 577 #define FLOAT_EXP_MIN (-(1 << (FLOAT_EXP_BITS - 1)))
 578 #define FLOAT_EXP_MAX (-FLOAT_EXP_MIN - 1)
 579 #define FLOAT_COEF_BITS ((int)sizeof(int32_t) * 8 - FLOAT_EXP_BITS)
 580 #define FLOAT_COEF_MIN (-(1 << (FLOAT_COEF_BITS - 1)))
 581 #define FLOAT_COEF_MAX (-FLOAT_COEF_MIN - 1)
 582
 583   int32_t exp, coef;
 584   uint32_t uval;
 585
 586   uval = ntohl(p_float.value);
 587   exp = (uval >> FLOAT_COEF_BITS) - FLOAT_COEF_BITS;
 588   if (exp >= 1 << (FLOAT_EXP_BITS - 1))
 589     exp -= 1 << FLOAT_EXP_BITS;
 590
 591   /* coef = (x << FLOAT_EXP_BITS) >> FLOAT_EXP_BITS; */
 592   coef = uval % (1U << FLOAT_COEF_BITS);
 593   if (coef >= 1 << (FLOAT_COEF_BITS - 1))
 594     coef -= 1 << FLOAT_COEF_BITS;
 595
 596   return coef * pow(2.0, exp);
 597 }
 598
 599 static void chrony_push_data(const char *p_type, const char *p_type_inst,
 600                              double p_value) {
 601   value_t values[1];
 602   value_list_t vl = VALUE_LIST_INIT;
 603
 604   values[0].gauge =
 605       p_value; /* TODO: Check type??? (counter, gauge, derive, absolute) */
 606
 607   vl.values = values;
 608   vl.values_len = 1;
 609
 610   /* XXX: Shall g_chrony_host/g_chrony_port be reflected in the plugin's output?
 611    */
 612   /* hostname_g is set in daemon/collectd.c (from config, via gethostname or by
 613    * resolving localhost) */
 614   /* defined as: char hostname_g[DATA_MAX_NAME_LEN]; (never NULL) */
 615   sstrncpy(vl.host, hostname_g, sizeof(vl.host));
 616   sstrncpy(vl.plugin, PLUGIN_NAME_SHORT, sizeof(vl.plugin));
 617   if (g_chrony_plugin_instance != NULL) {
 618     sstrncpy(vl.plugin_instance, g_chrony_plugin_instance,
 619              sizeof(vl.plugin_instance));
 620   }
 621   if (p_type != NULL)
 622     sstrncpy(vl.type, p_type, sizeof(vl.type));
 623
 624   if (p_type_inst != NULL)
 625     sstrncpy(vl.type_instance, p_type_inst, sizeof(vl.type_instance));
 626
 627   plugin_dispatch_values(&vl);
 628 }
 629
 630 static void chrony_push_data_valid(const char *p_type, const char *p_type_inst,
 631                                    const int p_is_valid, double p_value) {
 632   /* Push real value if p_is_valid is true, push NAN if p_is_valid is not true
 633    * (idea from ntp plugin) */
 634   if (p_is_valid == 0)
 635     p_value = NAN;
 636
 637   chrony_push_data(p_type, p_type_inst, p_value);
 638 }
 639
 640 static int chrony_init_seq(void) {
 641   /* Initialize the sequence number generator from /dev/urandom */
 642   /* Fallbacks: /dev/random and time(NULL) */
 643
 644   int fh;
 645
 646   /* Try urandom */
 647   fh = open(URAND_DEVICE_PATH, O_RDONLY);
 648   if (fh >= 0) {
 649     ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
 650     if (rc != sizeof(g_chrony_rand)) {
 651       ERROR(PLUGIN_NAME ": Reading from random source \'%s\'failed: %s (%d)",
 652             URAND_DEVICE_PATH, strerror(errno), errno);
 653       close(fh);
 654       return CHRONY_RC_FAIL;
 655     }
 656     close(fh);
 657     DEBUG(PLUGIN_NAME ": Seeding RNG from " URAND_DEVICE_PATH);
 658   } else {
 659     if (errno == ENOENT) {
 660       /* URAND_DEVICE_PATH device not found. Try RAND_DEVICE_PATH as fall-back
 661        */
 662       fh = open(RAND_DEVICE_PATH, O_RDONLY);
 663       if (fh >= 0) {
 664         ssize_t rc = read(fh, &g_chrony_rand, sizeof(g_chrony_rand));
 665         if (rc != sizeof(g_chrony_rand)) {
 666           ERROR(PLUGIN_NAME
 667                 ": Reading from random source \'%s\'failed: %s (%d)",
 668                 RAND_DEVICE_PATH, strerror(errno), errno);
 669           close(fh);
 670           return CHRONY_RC_FAIL;
 671         }
 672         close(fh);
 673         DEBUG(PLUGIN_NAME ": Seeding RNG from " RAND_DEVICE_PATH);
 674       } else {
 675         /* Error opening RAND_DEVICE_PATH. Try time(NULL) as fall-back */
 676         DEBUG(PLUGIN_NAME ": Seeding RNG from time(NULL)");
 677         g_chrony_rand = time(NULL) ^ getpid();
 678       }
 679     } else {
 680       ERROR(PLUGIN_NAME ": Opening random source \'%s\' failed: %s (%d)",
 681             URAND_DEVICE_PATH, strerror(errno), errno);
 682       return CHRONY_RC_FAIL;
 683     }
 684   }
 685
 686   return CHRONY_RC_OK;
 687 }
 688
 689 /*****************************************************************************/
 690 /* Exported functions */
 691 /*****************************************************************************/
 692 static int chrony_config(const char *p_key, const char *p_value) {
 693   assert(p_key);
 694   assert(p_value);
 695
 696   /* Parse config variables */
 697   if (strcasecmp(p_key, CONFIG_KEY_HOST) == 0) {
 698     if (g_chrony_host != NULL)
 699       free(g_chrony_host);
 700
 701     if ((g_chrony_host = strdup(p_value)) == NULL) {
 702       ERROR(PLUGIN_NAME ": Error duplicating host name");
 703       return CHRONY_RC_FAIL;
 704     }
 705   } else {
 706     if (strcasecmp(p_key, CONFIG_KEY_PORT) == 0) {
 707       if (g_chrony_port != NULL)
 708         free(g_chrony_port);
 709
 710       if ((g_chrony_port = strdup(p_value)) == NULL) {
 711         ERROR(PLUGIN_NAME ": Error duplicating port name");
 712         return CHRONY_RC_FAIL;
 713       }
 714     } else {
 715       if (strcasecmp(p_key, CONFIG_KEY_TIMEOUT) == 0) {
 716         time_t tosec = strtol(p_value, NULL, 0);
 717         g_chrony_timeout = tosec;
 718       } else {
 719         WARNING(PLUGIN_NAME ": Unknown configuration variable: %s %s", p_key,
 720                 p_value);
 721         return CHRONY_RC_FAIL;
 722       }
 723     }
 724   }
 725   /* XXX: We could set g_chrony_plugin_instance here to
 726    * "g_chrony_host-g_chrony_port", but as multiple instances aren't yet
 727    * supported, we skip this for now */
 728
 729   return CHRONY_RC_OK;
 730 }
 731
 732 static int chrony_request_daemon_stats(void) {
 733   /* Perform Tracking request */
 734   int rc;
 735   size_t chrony_resp_size;
 736   tChrony_Request chrony_req;
 737   tChrony_Response chrony_resp;
 738
 739   chrony_init_req(&chrony_req);
 740   rc = chrony_query(REQ_TRACKING, &chrony_req, &chrony_resp, &chrony_resp_size);
 741   if (rc != 0) {
 742     ERROR(PLUGIN_NAME ": chrony_query (REQ_TRACKING) failed with status %i",
 743           rc);
 744     return rc;
 745   }
 746 #if COLLECT_DEBUG
 747   {
 748     char src_addr[IPV6_STR_MAX_SIZE] = {0};
 749     niptoha(&chrony_resp.body.tracking.addr, src_addr, sizeof(src_addr));
 750     DEBUG(PLUGIN_NAME
 751           ": Daemon stat: .addr = %s, .ref_id= %u, .stratum = %u, .leap_status "
 752           "= %u, .ref_time = %u:%u:%u, .current_correction = %f, .last_offset "
 753           "= %f, .rms_offset = %f, .freq_ppm = %f, .skew_ppm = %f, .root_delay "
 754           "= %f, .root_dispersion = %f, .last_update_interval = %f",
 755           src_addr, ntohs(chrony_resp.body.tracking.f_ref_id),
 756           ntohs(chrony_resp.body.tracking.f_stratum),
 757           ntohs(chrony_resp.body.tracking.f_leap_status),
 758           ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high),
 759           ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low),
 760           ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec),
 761           ntohf(chrony_resp.body.tracking.f_current_correction),
 762           ntohf(chrony_resp.body.tracking.f_last_offset),
 763           ntohf(chrony_resp.body.tracking.f_rms_offset),
 764           ntohf(chrony_resp.body.tracking.f_freq_ppm),
 765           ntohf(chrony_resp.body.tracking.f_skew_ppm),
 766           ntohf(chrony_resp.body.tracking.f_root_delay),
 767           ntohf(chrony_resp.body.tracking.f_root_dispersion),
 768           ntohf(chrony_resp.body.tracking.f_last_update_interval));
 769   }
 770 #endif
 771
 772   double time_ref = ntohl(chrony_resp.body.tracking.f_ref_time.tv_nsec);
 773   time_ref /= 1000000000.0;
 774   time_ref += ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_low);
 775   if (chrony_resp.body.tracking.f_ref_time.tv_sec_high) {
 776     double secs_high = ntohl(chrony_resp.body.tracking.f_ref_time.tv_sec_high);
 777     secs_high *= 4294967296.0;
 778     time_ref += secs_high;
 779   }
 780
 781   /* Forward results to collectd-daemon */
 782   /* Type_instance is always 'chrony' to tag daemon-wide data */
 783   /*                Type                Type_instan  Value */
 784   chrony_push_data("clock_stratum", DAEMON_NAME,
 785                    ntohs(chrony_resp.body.tracking.f_stratum));
 786   chrony_push_data("time_ref", DAEMON_NAME, time_ref); /* unit: s */
 787   chrony_push_data(
 788       "time_offset_ntp", DAEMON_NAME,
 789       ntohf(chrony_resp.body.tracking.f_current_correction)); /* Offset between
 790                                                                  system time and
 791                                                                  NTP, unit: s */
 792   chrony_push_data(
 793       "time_offset", DAEMON_NAME,
 794       ntohf(
 795           chrony_resp.body.tracking
 796               .f_last_offset)); /* Estimated Offset of the NTP time, unit: s */
 797   chrony_push_data(
 798       "time_offset_rms", DAEMON_NAME,
 799       ntohf(chrony_resp.body.tracking
 800                 .f_rms_offset)); /* averaged value of the above, unit: s */
 801   chrony_push_data(
 802       "frequency_error", DAEMON_NAME,
 803       ntohf(chrony_resp.body.tracking
 804                 .f_freq_ppm)); /* Frequency error of the local osc, unit: ppm */
 805   chrony_push_data("clock_skew_ppm", DAEMON_NAME,
 806                    ntohf(chrony_resp.body.tracking.f_skew_ppm));
 807   chrony_push_data(
 808       "root_delay", DAEMON_NAME,
 809       ntohf(chrony_resp.body.tracking.f_root_delay)); /* Network latency between
 810                                                          local daemon and the
 811                                                          current source */
 812   chrony_push_data("root_dispersion", DAEMON_NAME,
 813                    ntohf(chrony_resp.body.tracking.f_root_dispersion));
 814   chrony_push_data("clock_last_update", DAEMON_NAME,
 815                    ntohf(chrony_resp.body.tracking.f_last_update_interval));
 816
 817   return CHRONY_RC_OK;
 818 }
 819
 820 static int chrony_request_sources_count(unsigned int *p_count) {
 821   /* Requests the number of time sources from the chrony daemon */
 822   int rc;
 823   size_t chrony_resp_size;
 824   tChrony_Request chrony_req;
 825   tChrony_Response chrony_resp;
 826
 827   DEBUG(PLUGIN_NAME ": Requesting data");
 828   chrony_init_req(&chrony_req);
 829   rc =
 830       chrony_query(REQ_N_SOURCES, &chrony_req, &chrony_resp, &chrony_resp_size);
 831   if (rc != 0) {
 832     ERROR(PLUGIN_NAME ": chrony_query (REQ_N_SOURCES) failed with status %i",
 833           rc);
 834     return rc;
 835   }
 836
 837   *p_count = ntohl(chrony_resp.body.n_sources.f_n_sources);
 838   DEBUG(PLUGIN_NAME ": Getting data of %d clock sources", *p_count);
 839
 840   return CHRONY_RC_OK;
 841 }
 842
 843 static int chrony_request_source_data(int p_src_idx, int *p_is_reachable) {
 844   /* Perform Source data request for source #p_src_idx */
 845   int rc;
 846   size_t chrony_resp_size;
 847   tChrony_Request chrony_req;
 848   tChrony_Response chrony_resp;
 849
 850   char src_addr[IPV6_STR_MAX_SIZE] = {0};
 851
 852   chrony_init_req(&chrony_req);
 853   chrony_req.body.source_data.f_index = htonl(p_src_idx);
 854   rc = chrony_query(REQ_SOURCE_DATA, &chrony_req, &chrony_resp,
 855                     &chrony_resp_size);
 856   if (rc != 0) {
 857     ERROR(PLUGIN_NAME ": chrony_query (REQ_SOURCE_DATA) failed with status %i",
 858           rc);
 859     return rc;
 860   }
 861
 862   niptoha(&chrony_resp.body.source_data.addr, src_addr, sizeof(src_addr));
 863   DEBUG(PLUGIN_NAME ": Source[%d] data: .addr = %s, .poll = %u, .stratum = %u, "
 864                     ".state = %u, .mode = %u, .flags = %u, .reach = %u, "
 865                     ".latest_meas_ago = %u, .orig_latest_meas = %f, "
 866                     ".latest_meas = %f, .latest_meas_err = %f",
 867         p_src_idx, src_addr, ntohs(chrony_resp.body.source_data.f_poll),
 868         ntohs(chrony_resp.body.source_data.f_stratum),
 869         ntohs(chrony_resp.body.source_data.f_state),
 870         ntohs(chrony_resp.body.source_data.f_mode),
 871         ntohs(chrony_resp.body.source_data.f_flags),
 872         ntohs(chrony_resp.body.source_data.f_reachability),
 873         ntohl(chrony_resp.body.source_data.f_since_sample),
 874         ntohf(chrony_resp.body.source_data.f_origin_latest_meas),
 875         ntohf(chrony_resp.body.source_data.f_latest_meas),
 876         ntohf(chrony_resp.body.source_data.f_latest_meas_err));
 877
 878   /* Push NaN if source is currently not reachable */
 879   int is_reachable = ntohs(chrony_resp.body.source_data.f_reachability) & 0x01;
 880   *p_is_reachable = is_reachable;
 881
 882   /* Forward results to collectd-daemon */
 883   chrony_push_data_valid("clock_stratum", src_addr, is_reachable,
 884                          ntohs(chrony_resp.body.source_data.f_stratum));
 885   chrony_push_data_valid("clock_state", src_addr, is_reachable,
 886                          ntohs(chrony_resp.body.source_data.f_state));
 887   chrony_push_data_valid("clock_mode", src_addr, is_reachable,
 888                          ntohs(chrony_resp.body.source_data.f_mode));
 889   chrony_push_data_valid("clock_reachability", src_addr, is_reachable,
 890                          ntohs(chrony_resp.body.source_data.f_reachability));
 891   chrony_push_data_valid("clock_last_meas", src_addr, is_reachable,
 892                          ntohs(chrony_resp.body.source_data.f_since_sample));
 893
 894   return CHRONY_RC_OK;
 895 }
 896
 897 static int chrony_request_source_stats(int p_src_idx,
 898                                        const int *p_is_reachable) {
 899   /* Perform Source stats request for source #p_src_idx */
 900   int rc;
 901   size_t chrony_resp_size;
 902   tChrony_Request chrony_req;
 903   tChrony_Response chrony_resp;
 904   double skew_ppm, frequency_error, time_offset;
 905
 906   char src_addr[IPV6_STR_MAX_SIZE] = {0};
 907
 908   if (*p_is_reachable == 0) {
 909     skew_ppm = 0;
 910     frequency_error = 0;
 911     time_offset = 0;
 912   } else {
 913     chrony_init_req(&chrony_req);
 914     chrony_req.body.source_stats.f_index = htonl(p_src_idx);
 915     rc = chrony_query(REQ_SOURCE_STATS, &chrony_req, &chrony_resp,
 916                       &chrony_resp_size);
 917     if (rc != 0) {
 918       ERROR(PLUGIN_NAME
 919             ": chrony_query (REQ_SOURCE_STATS) failed with status %i",
 920             rc);
 921       return rc;
 922     }
 923
 924     skew_ppm = ntohf(chrony_resp.body.source_stats.f_skew_ppm);
 925     frequency_error = ntohf(chrony_resp.body.source_stats.f_rtc_gain_rate_ppm);
 926     time_offset = ntohf(chrony_resp.body.source_stats.f_est_offset);
 927
 928     niptoha(&chrony_resp.body.source_stats.addr, src_addr, sizeof(src_addr));
 929     DEBUG(PLUGIN_NAME
 930           ": Source[%d] stat: .addr = %s, .ref_id= %u, .n_samples = %u, "
 931           ".n_runs = %u, .span_seconds = %u, .rtc_seconds_fast = %f, "
 932           ".rtc_gain_rate_ppm = %f, .skew_ppm= %f, .est_offset = %f, "
 933           ".est_offset_err = %f",
 934           p_src_idx, src_addr, ntohl(chrony_resp.body.source_stats.f_ref_id),
 935           ntohl(chrony_resp.body.source_stats.f_n_samples),
 936           ntohl(chrony_resp.body.source_stats.f_n_runs),
 937           ntohl(chrony_resp.body.source_stats.f_span_seconds),
 938           ntohf(chrony_resp.body.source_stats.f_rtc_seconds_fast),
 939           frequency_error, skew_ppm, time_offset,
 940           ntohf(chrony_resp.body.source_stats.f_est_offset_err));
 941
 942   } /* if (*is_reachable) */
 943
 944   /* Forward results to collectd-daemon */
 945   chrony_push_data_valid("clock_skew_ppm", src_addr, *p_is_reachable, skew_ppm);
 946   chrony_push_data_valid("frequency_error", src_addr, *p_is_reachable,
 947                          frequency_error); /* unit: ppm */
 948   chrony_push_data_valid("time_offset", src_addr, *p_is_reachable,
 949                          time_offset); /* unit: s */
 950
 951   return CHRONY_RC_OK;
 952 }
 953
 954 static int chrony_read(void) {
 955   /* collectd read callback: Perform data acquisition */
 956   int rc;
 957   unsigned int n_sources;
 958
 959   if (g_chrony_seq_is_initialized == 0) {
 960     /* Seed RNG for sequence number generation */
 961     rc = chrony_init_seq();
 962     if (rc != CHRONY_RC_OK)
 963       return rc;
 964
 965     g_chrony_seq_is_initialized = 1;
 966   }
 967
 968   /* Get daemon stats */
 969   rc = chrony_request_daemon_stats();
 970   if (rc != CHRONY_RC_OK)
 971     return rc;
 972
 973   /* Get number of time sources, then check every source for status */
 974   rc = chrony_request_sources_count(&n_sources);
 975   if (rc != CHRONY_RC_OK)
 976     return rc;
 977
 978   for (unsigned int now_src = 0; now_src < n_sources; ++now_src) {
 979     int is_reachable;
 980     rc = chrony_request_source_data(now_src, &is_reachable);
 981     if (rc != CHRONY_RC_OK)
 982       return rc;
 983
 984     rc = chrony_request_source_stats(now_src, &is_reachable);
 985     if (rc != CHRONY_RC_OK)
 986       return rc;
 987   }
 988   return CHRONY_RC_OK;
 989 }
 990
 991 static int chrony_shutdown(void) {
 992   /* Collectd shutdown callback: Free mem */
 993   if (g_chrony_is_connected != 0) {
 994     close(g_chrony_socket);
 995     g_chrony_is_connected = 0;
 996   }
 997   if (g_chrony_host != NULL)
 998     sfree(g_chrony_host);
 999
1000   if (g_chrony_port != NULL)
1001     sfree(g_chrony_port);
1002
1003   if (g_chrony_plugin_instance != NULL)
1004     sfree(g_chrony_plugin_instance);
1005
1006   return CHRONY_RC_OK;
1007 }
1008
1009 void module_register(void) {
1010   plugin_register_config(PLUGIN_NAME_SHORT, chrony_config, g_config_keys,
1011                          g_config_keys_num);
1012   plugin_register_read(PLUGIN_NAME_SHORT, chrony_read);
1013   plugin_register_shutdown(PLUGIN_NAME_SHORT, chrony_shutdown);
1014 }