src/bind.c

   1 /**
   2  * collectd - src/bind.c
   3  * Copyright (C) 2009       Bruno Prémont
   4  * Copyright (C) 2009,2010  Florian Forster
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Bruno Prémont <bonbons at linux-vserver.org>
  21  *   Florian Forster <octo at collectd.org>
  22  **/
  23
  24 #include "config.h"
  25
  26 #if STRPTIME_NEEDS_STANDARDS
  27 #ifndef _ISOC99_SOURCE
  28 #define _ISOC99_SOURCE 1
  29 #endif
  30 #ifndef _POSIX_C_SOURCE
  31 #define _POSIX_C_SOURCE 200112L
  32 #endif
  33 #ifndef _XOPEN_SOURCE
  34 #define _XOPEN_SOURCE 500
  35 #endif
  36 #endif /* STRPTIME_NEEDS_STANDARDS */
  37
  38 #if TIMEGM_NEEDS_BSD
  39 #ifndef _BSD_SOURCE
  40 #define _BSD_SOURCE 1
  41 #endif
  42 #endif /* TIMEGM_NEEDS_BSD */
  43
  44 #include "collectd.h"
  45
  46 #include "common.h"
  47 #include "plugin.h"
  48
  49 #include <time.h>
  50
  51 /* Some versions of libcurl don't include this themselves and then don't have
  52  * fd_set available. */
  53 #if HAVE_SYS_SELECT_H
  54 #include <sys/select.h>
  55 #endif
  56
  57 #include <curl/curl.h>
  58 #include <libxml/parser.h>
  59 #include <libxml/xpath.h>
  60
  61 #ifndef BIND_DEFAULT_URL
  62 #define BIND_DEFAULT_URL "http://localhost:8053/"
  63 #endif
  64
  65 /*
  66  * Some types used for the callback functions. `translation_table_ptr_t' and
  67  * `list_info_ptr_t' are passed to the callbacks in the `void *user_data'
  68  * pointer.
  69  */
  70 typedef int (*list_callback_t)(const char *name, value_t value,
  71                                time_t current_time, void *user_data);
  72
  73 struct cb_view_s {
  74   char *name;
  75
  76   int qtypes;
  77   int resolver_stats;
  78   int cacherrsets;
  79
  80   char **zones;
  81   size_t zones_num;
  82 };
  83 typedef struct cb_view_s cb_view_t;
  84
  85 struct translation_info_s {
  86   const char *xml_name;
  87   const char *type;
  88   const char *type_instance;
  89 };
  90 typedef struct translation_info_s translation_info_t;
  91
  92 struct translation_table_ptr_s {
  93   const translation_info_t *table;
  94   size_t table_length;
  95   const char *plugin_instance;
  96 };
  97 typedef struct translation_table_ptr_s translation_table_ptr_t;
  98
  99 struct list_info_ptr_s {
 100   const char *plugin_instance;
 101   const char *type;
 102 };
 103 typedef struct list_info_ptr_s list_info_ptr_t;
 104
 105 /* FIXME: Enabled by default for backwards compatibility. */
 106 /* TODO: Remove time parsing code. */
 107 static bool config_parse_time = true;
 108
 109 static char *url;
 110 static int global_opcodes = 1;
 111 static int global_qtypes = 1;
 112 static int global_server_stats = 1;
 113 static int global_zone_maint_stats = 1;
 114 static int global_resolver_stats;
 115 static int global_memory_stats = 1;
 116 static int timeout = -1;
 117
 118 static cb_view_t *views;
 119 static size_t views_num;
 120
 121 static CURL *curl;
 122
 123 static char *bind_buffer;
 124 static size_t bind_buffer_size;
 125 static size_t bind_buffer_fill;
 126 static char bind_curl_error[CURL_ERROR_SIZE];
 127
 128 /* Translation table for the `nsstats' values. */
 129 static const translation_info_t nsstats_translation_table[] = /* {{{ */
 130     {
 131         /* Requests */
 132         {"Requestv4", "dns_request", "IPv4"},
 133         {"Requestv6", "dns_request", "IPv6"},
 134         {"ReqEdns0", "dns_request", "EDNS0"},
 135         {"ReqBadEDNSVer", "dns_request", "BadEDNSVer"},
 136         {"ReqTSIG", "dns_request", "TSIG"},
 137         {"ReqSIG0", "dns_request", "SIG0"},
 138         {"ReqBadSIG", "dns_request", "BadSIG"},
 139         {"ReqTCP", "dns_request", "TCP"},
 140         /* Rejects */
 141         {"AuthQryRej", "dns_reject", "authoritative"},
 142         {"RecQryRej", "dns_reject", "recursive"},
 143         {"XfrRej", "dns_reject", "transfer"},
 144         {"UpdateRej", "dns_reject", "update"},
 145         /* Responses */
 146         {"Response", "dns_response", "normal"},
 147         {"TruncatedResp", "dns_response", "truncated"},
 148         {"RespEDNS0", "dns_response", "EDNS0"},
 149         {"RespTSIG", "dns_response", "TSIG"},
 150         {"RespSIG0", "dns_response", "SIG0"},
 151         /* Queries */
 152         {"QryAuthAns", "dns_query", "authoritative"},
 153         {"QryNoauthAns", "dns_query", "nonauth"},
 154         {"QryReferral", "dns_query", "referral"},
 155         {"QryRecursion", "dns_query", "recursion"},
 156         {"QryDuplicate", "dns_query", "duplicate"},
 157         {"QryDropped", "dns_query", "dropped"},
 158         {"QryFailure", "dns_query", "failure"},
 159         /* Response codes */
 160         {"QrySuccess", "dns_rcode", "tx-NOERROR"},
 161         {"QryNxrrset", "dns_rcode", "tx-NXRRSET"},
 162         {"QrySERVFAIL", "dns_rcode", "tx-SERVFAIL"},
 163         {"QryFORMERR", "dns_rcode", "tx-FORMERR"},
 164         {"QryNXDOMAIN", "dns_rcode", "tx-NXDOMAIN"}
 165 #if 0
 166   { "XfrReqDone",      "type",         "type_instance" },
 167   { "UpdateReqFwd",    "type",         "type_instance" },
 168   { "UpdateRespFwd",   "type",         "type_instance" },
 169   { "UpdateFwdFail",   "type",         "type_instance" },
 170   { "UpdateDone",      "type",         "type_instance" },
 171   { "UpdateFail",      "type",         "type_instance" },
 172   { "UpdateBadPrereq", "type",         "type_instance" },
 173 #endif
 174 };
 175 static int nsstats_translation_table_length =
 176     STATIC_ARRAY_SIZE(nsstats_translation_table);
 177 /* }}} */
 178
 179 /* Translation table for the `zonestats' values. */
 180 static const translation_info_t zonestats_translation_table[] = /* {{{ */
 181     {
 182         /* Notify's */
 183         {"NotifyOutv4", "dns_notify", "tx-IPv4"},
 184         {"NotifyOutv6", "dns_notify", "tx-IPv6"},
 185         {"NotifyInv4", "dns_notify", "rx-IPv4"},
 186         {"NotifyInv6", "dns_notify", "rx-IPv6"},
 187         {"NotifyRej", "dns_notify", "rejected"},
 188         /* SOA/AXFS/IXFS requests */
 189         {"SOAOutv4", "dns_opcode", "SOA-IPv4"},
 190         {"SOAOutv6", "dns_opcode", "SOA-IPv6"},
 191         {"AXFRReqv4", "dns_opcode", "AXFR-IPv4"},
 192         {"AXFRReqv6", "dns_opcode", "AXFR-IPv6"},
 193         {"IXFRReqv4", "dns_opcode", "IXFR-IPv4"},
 194         {"IXFRReqv6", "dns_opcode", "IXFR-IPv6"},
 195         /* Domain transfers */
 196         {"XfrSuccess", "dns_transfer", "success"},
 197         {"XfrFail", "dns_transfer", "failure"}};
 198 static int zonestats_translation_table_length =
 199     STATIC_ARRAY_SIZE(zonestats_translation_table);
 200 /* }}} */
 201
 202 /* Translation table for the `resstats' values. */
 203 static const translation_info_t resstats_translation_table[] = /* {{{ */
 204     {
 205         /* Generic resolver information */
 206         {"Queryv4", "dns_query", "IPv4"},
 207         {"Queryv6", "dns_query", "IPv6"},
 208         {"Responsev4", "dns_response", "IPv4"},
 209         {"Responsev6", "dns_response", "IPv6"},
 210         /* Received response codes */
 211         {"NXDOMAIN", "dns_rcode", "rx-NXDOMAIN"},
 212         {"SERVFAIL", "dns_rcode", "rx-SERVFAIL"},
 213         {"FORMERR", "dns_rcode", "rx-FORMERR"},
 214         {"OtherError", "dns_rcode", "rx-OTHER"},
 215         {"EDNS0Fail", "dns_rcode", "rx-EDNS0Fail"},
 216         /* Received responses */
 217         {"Mismatch", "dns_response", "mismatch"},
 218         {"Truncated", "dns_response", "truncated"},
 219         {"Lame", "dns_response", "lame"},
 220         {"Retry", "dns_query", "retry"},
 221 #if 0
 222   { "GlueFetchv4",     "type", "type_instance" },
 223   { "GlueFetchv6",     "type", "type_instance" },
 224   { "GlueFetchv4Fail", "type", "type_instance" },
 225   { "GlueFetchv6Fail", "type", "type_instance" },
 226 #endif
 227         /* DNSSEC information */
 228         {"ValAttempt", "dns_resolver", "DNSSEC-attempt"},
 229         {"ValOk", "dns_resolver", "DNSSEC-okay"},
 230         {"ValNegOk", "dns_resolver", "DNSSEC-negokay"},
 231         {"ValFail", "dns_resolver", "DNSSEC-fail"}};
 232 static int resstats_translation_table_length =
 233     STATIC_ARRAY_SIZE(resstats_translation_table);
 234 /* }}} */
 235
 236 /* Translation table for the `memory/summary' values. */
 237 static const translation_info_t memsummary_translation_table[] = /* {{{ */
 238     {{"TotalUse", "memory", "TotalUse"},
 239      {"InUse", "memory", "InUse"},
 240      {"BlockSize", "memory", "BlockSize"},
 241      {"ContextSize", "memory", "ContextSize"},
 242      {"Lost", "memory", "Lost"}};
 243 static int memsummary_translation_table_length =
 244     STATIC_ARRAY_SIZE(memsummary_translation_table);
 245 /* }}} */
 246
 247 static void submit(time_t ts, const char *plugin_instance, /* {{{ */
 248                    const char *type, const char *type_instance, value_t value) {
 249   value_list_t vl = VALUE_LIST_INIT;
 250
 251   vl.values = &value;
 252   vl.values_len = 1;
 253   if (config_parse_time)
 254     vl.time = TIME_T_TO_CDTIME_T(ts);
 255   sstrncpy(vl.plugin, "bind", sizeof(vl.plugin));
 256   if (plugin_instance) {
 257     sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
 258     replace_special(vl.plugin_instance, sizeof(vl.plugin_instance));
 259   }
 260   sstrncpy(vl.type, type, sizeof(vl.type));
 261   if (type_instance) {
 262     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 263     replace_special(vl.type_instance, sizeof(vl.type_instance));
 264   }
 265   plugin_dispatch_values(&vl);
 266 } /* }}} void submit */
 267
 268 static size_t bind_curl_callback(void *buf, size_t size, /* {{{ */
 269                                  size_t nmemb,
 270                                  void __attribute__((unused)) * stream) {
 271   size_t len = size * nmemb;
 272
 273   if (len == 0)
 274     return len;
 275
 276   if ((bind_buffer_fill + len) >= bind_buffer_size) {
 277     char *temp = realloc(bind_buffer, bind_buffer_fill + len + 1);
 278     if (temp == NULL) {
 279       ERROR("bind plugin: realloc failed.");
 280       return 0;
 281     }
 282     bind_buffer = temp;
 283     bind_buffer_size = bind_buffer_fill + len + 1;
 284   }
 285
 286   memcpy(bind_buffer + bind_buffer_fill, (char *)buf, len);
 287   bind_buffer_fill += len;
 288   bind_buffer[bind_buffer_fill] = 0;
 289
 290   return len;
 291 } /* }}} size_t bind_curl_callback */
 292
 293 /*
 294  * Callback, that's called with a translation table.
 295  * (Plugin instance is fixed, type and type instance come from lookup table.)
 296  */
 297 static int bind_xml_table_callback(const char *name, value_t value, /* {{{ */
 298                                    time_t current_time, void *user_data) {
 299   translation_table_ptr_t *table = (translation_table_ptr_t *)user_data;
 300
 301   if (table == NULL)
 302     return -1;
 303
 304   for (size_t i = 0; i < table->table_length; i++) {
 305     if (strcmp(table->table[i].xml_name, name) != 0)
 306       continue;
 307
 308     submit(current_time, table->plugin_instance, table->table[i].type,
 309            table->table[i].type_instance, value);
 310     break;
 311   }
 312
 313   return 0;
 314 } /* }}} int bind_xml_table_callback */
 315
 316 /*
 317  * Callback, that's used for lists.
 318  * (Plugin instance and type are fixed, xml name is used as type instance.)
 319  */
 320 static int bind_xml_list_callback(const char *name, /* {{{ */
 321                                   value_t value, time_t current_time,
 322                                   void *user_data) {
 323   list_info_ptr_t *list_info = (list_info_ptr_t *)user_data;
 324
 325   if (list_info == NULL)
 326     return -1;
 327
 328   submit(current_time, list_info->plugin_instance, list_info->type,
 329          /* type instance = */ name, value);
 330
 331   return 0;
 332 } /* }}} int bind_xml_list_callback */
 333
 334 static int bind_xml_read_derive(xmlDoc *doc, xmlNode *node, /* {{{ */
 335                                 derive_t *ret_value) {
 336   char *str_ptr = (char *)xmlNodeListGetString(doc, node->xmlChildrenNode, 1);
 337   if (str_ptr == NULL) {
 338     ERROR("bind plugin: bind_xml_read_derive: xmlNodeListGetString failed.");
 339     return -1;
 340   }
 341
 342   value_t value;
 343
 344   int status = parse_value(str_ptr, &value, DS_TYPE_DERIVE);
 345   if (status != 0) {
 346     ERROR("bind plugin: Parsing string \"%s\" to derive value failed.",
 347           str_ptr);
 348     xmlFree(str_ptr);
 349     return -1;
 350   }
 351
 352   xmlFree(str_ptr);
 353   *ret_value = value.derive;
 354   return 0;
 355 } /* }}} int bind_xml_read_derive */
 356
 357 static int bind_xml_read_gauge(xmlDoc *doc, xmlNode *node, /* {{{ */
 358                                gauge_t *ret_value) {
 359   char *str_ptr = (char *)xmlNodeListGetString(doc, node->xmlChildrenNode, 1);
 360   if (str_ptr == NULL) {
 361     ERROR("bind plugin: bind_xml_read_gauge: xmlNodeListGetString failed.");
 362     return -1;
 363   }
 364
 365   char *end_ptr;
 366   errno = 0;
 367   double value = strtod(str_ptr, &end_ptr);
 368   xmlFree(str_ptr);
 369   if (str_ptr == end_ptr || errno) {
 370     if (errno && (value < 0))
 371       ERROR("bind plugin: bind_xml_read_gauge: strtod failed with underflow.");
 372     else if (errno && (value > 0))
 373       ERROR("bind plugin: bind_xml_read_gauge: strtod failed with overflow.");
 374     else
 375       ERROR("bind plugin: bind_xml_read_gauge: strtod failed.");
 376     return -1;
 377   }
 378
 379   *ret_value = (gauge_t)value;
 380   return 0;
 381 } /* }}} int bind_xml_read_gauge */
 382
 383 static int bind_xml_read_timestamp(const char *xpath_expression, /* {{{ */
 384                                    xmlDoc *doc, xmlXPathContext *xpathCtx,
 385                                    time_t *ret_value) {
 386   xmlXPathObject *xpathObj =
 387       xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
 388   if (xpathObj == NULL) {
 389     ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
 390           xpath_expression);
 391     return -1;
 392   }
 393
 394   if ((xpathObj->nodesetval == NULL) || (xpathObj->nodesetval->nodeNr < 1)) {
 395     xmlXPathFreeObject(xpathObj);
 396     return -1;
 397   }
 398
 399   if (xpathObj->nodesetval->nodeNr != 1) {
 400     NOTICE("bind plugin: Evaluating the XPath expression `%s' returned "
 401            "%i nodes. Only handling the first one.",
 402            xpath_expression, xpathObj->nodesetval->nodeNr);
 403   }
 404
 405   xmlNode *node = xpathObj->nodesetval->nodeTab[0];
 406
 407   if (node->xmlChildrenNode == NULL) {
 408     ERROR("bind plugin: bind_xml_read_timestamp: "
 409           "node->xmlChildrenNode == NULL");
 410     xmlXPathFreeObject(xpathObj);
 411     return -1;
 412   }
 413
 414   char *str_ptr = (char *)xmlNodeListGetString(doc, node->xmlChildrenNode, 1);
 415   if (str_ptr == NULL) {
 416     ERROR("bind plugin: bind_xml_read_timestamp: xmlNodeListGetString failed.");
 417     xmlXPathFreeObject(xpathObj);
 418     return -1;
 419   }
 420
 421   struct tm tm = {0};
 422   char *tmp = strptime(str_ptr, "%Y-%m-%dT%T", &tm);
 423   xmlFree(str_ptr);
 424   if (tmp == NULL) {
 425     ERROR("bind plugin: bind_xml_read_timestamp: strptime failed.");
 426     xmlXPathFreeObject(xpathObj);
 427     return -1;
 428   }
 429
 430 #if HAVE_TIMEGM
 431   time_t t = timegm(&tm);
 432   if (t == ((time_t)-1)) {
 433     ERROR("bind plugin: timegm() failed: %s", STRERRNO);
 434     return -1;
 435   }
 436   *ret_value = t;
 437 #else
 438   time_t t = mktime(&tm);
 439   if (t == ((time_t)-1)) {
 440     ERROR("bind plugin: mktime() failed: %s", STRERRNO);
 441     return -1;
 442   }
 443   /* mktime assumes that tm is local time. Luckily, it also sets timezone to
 444    * the offset used for the conversion, and we undo the conversion to convert
 445    * back to UTC. */
 446   *ret_value = t - timezone;
 447 #endif
 448
 449   xmlXPathFreeObject(xpathObj);
 450   return 0;
 451 } /* }}} int bind_xml_read_timestamp */
 452
 453 /*
 454  * bind_parse_generic_name_value
 455  *
 456  * Reads statistics in the form:
 457  * <foo>
 458  *   <name>QUERY</name>
 459  *   <counter>123</counter>
 460  * </foo>
 461  */
 462 static int bind_parse_generic_name_value(const char *xpath_expression, /* {{{ */
 463                                          list_callback_t list_callback,
 464                                          void *user_data, xmlDoc *doc,
 465                                          xmlXPathContext *xpathCtx,
 466                                          time_t current_time, int ds_type) {
 467   xmlXPathObject *xpathObj =
 468       xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
 469   if (xpathObj == NULL) {
 470     ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
 471           xpath_expression);
 472     return -1;
 473   }
 474
 475   int num_entries = 0;
 476   /* Iterate over all matching nodes. */
 477   for (int i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr);
 478        i++) {
 479
 480     xmlNode *name_node = NULL;
 481     xmlNode *counter = NULL;
 482
 483     xmlNode *parent = xpathObj->nodesetval->nodeTab[i];
 484     DEBUG("bind plugin: bind_parse_generic_name_value: parent->name = %s;",
 485           (char *)parent->name);
 486
 487     /* Iterate over all child nodes. */
 488     for (xmlNode *child = parent->xmlChildrenNode; child != NULL;
 489          child = child->next) {
 490       if (child->type != XML_ELEMENT_NODE)
 491         continue;
 492
 493       if (xmlStrcmp(BAD_CAST "name", child->name) == 0)
 494         name_node = child;
 495       else if (xmlStrcmp(BAD_CAST "counter", child->name) == 0)
 496         counter = child;
 497     }
 498
 499     if ((name_node != NULL) && (counter != NULL)) {
 500       char *name =
 501           (char *)xmlNodeListGetString(doc, name_node->xmlChildrenNode, 1);
 502       value_t value;
 503       int status;
 504
 505       if (ds_type == DS_TYPE_GAUGE)
 506         status = bind_xml_read_gauge(doc, counter, &value.gauge);
 507       else
 508         status = bind_xml_read_derive(doc, counter, &value.derive);
 509       if (status != 0) {
 510         xmlFree(name);
 511         continue;
 512       }
 513
 514       status = (*list_callback)(name, value, current_time, user_data);
 515       if (status == 0)
 516         num_entries++;
 517
 518       xmlFree(name);
 519     }
 520   }
 521
 522   DEBUG("bind plugin: Found %d %s for XPath expression `%s'", num_entries,
 523         (num_entries == 1) ? "entry" : "entries", xpath_expression);
 524
 525   xmlXPathFreeObject(xpathObj);
 526
 527   return 0;
 528 } /* }}} int bind_parse_generic_name_value */
 529
 530 /*
 531  * bind_parse_generic_value_list
 532  *
 533  * Reads statistics in the form:
 534  * <foo>
 535  *   <name0>123</name0>
 536  *   <name1>234</name1>
 537  *   <name2>345</name2>
 538  *   :
 539  * </foo>
 540  */
 541 static int bind_parse_generic_value_list(const char *xpath_expression, /* {{{ */
 542                                          list_callback_t list_callback,
 543                                          void *user_data, xmlDoc *doc,
 544                                          xmlXPathContext *xpathCtx,
 545                                          time_t current_time, int ds_type) {
 546   xmlXPathObject *xpathObj =
 547       xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
 548   if (xpathObj == NULL) {
 549     ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
 550           xpath_expression);
 551     return -1;
 552   }
 553
 554   int num_entries = 0;
 555   /* Iterate over all matching nodes. */
 556   for (int i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr);
 557        i++) {
 558     /* Iterate over all child nodes. */
 559     for (xmlNode *child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
 560          child != NULL; child = child->next) {
 561
 562       if (child->type != XML_ELEMENT_NODE)
 563         continue;
 564
 565       char *node_name = (char *)child->name;
 566
 567       value_t value;
 568       int status;
 569       if (ds_type == DS_TYPE_GAUGE)
 570         status = bind_xml_read_gauge(doc, child, &value.gauge);
 571       else
 572         status = bind_xml_read_derive(doc, child, &value.derive);
 573       if (status != 0)
 574         continue;
 575
 576       status = (*list_callback)(node_name, value, current_time, user_data);
 577       if (status == 0)
 578         num_entries++;
 579     }
 580   }
 581
 582   DEBUG("bind plugin: Found %d %s for XPath expression `%s'", num_entries,
 583         (num_entries == 1) ? "entry" : "entries", xpath_expression);
 584
 585   xmlXPathFreeObject(xpathObj);
 586
 587   return 0;
 588 } /* }}} int bind_parse_generic_value_list */
 589
 590 /*
 591  * bind_parse_generic_name_attr_value_list
 592  *
 593  * Reads statistics in the form:
 594  * <foo>
 595  *   <counter name="name0">123</counter>
 596  *   <counter name="name1">234</counter>
 597  *   <counter name="name2">345</counter>
 598  *   :
 599  * </foo>
 600  */
 601 static int bind_parse_generic_name_attr_value_list(
 602     const char *xpath_expression, /* {{{ */
 603     list_callback_t list_callback, void *user_data, xmlDoc *doc,
 604     xmlXPathContext *xpathCtx, time_t current_time, int ds_type) {
 605
 606   xmlXPathObject *xpathObj =
 607       xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
 608   if (xpathObj == NULL) {
 609     ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
 610           xpath_expression);
 611     return -1;
 612   }
 613
 614   int num_entries = 0;
 615   /* Iterate over all matching nodes. */
 616   for (int i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr);
 617        i++) {
 618     /* Iterate over all child nodes. */
 619     for (xmlNode *child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
 620          child != NULL; child = child->next) {
 621       if (child->type != XML_ELEMENT_NODE)
 622         continue;
 623
 624       if (strncmp("counter", (char *)child->name, strlen("counter")) != 0)
 625         continue;
 626
 627       char *attr_name = (char *)xmlGetProp(child, BAD_CAST "name");
 628       if (attr_name == NULL) {
 629         DEBUG("bind plugin: found <counter> without name.");
 630         continue;
 631       }
 632
 633       value_t value;
 634       int status;
 635
 636       if (ds_type == DS_TYPE_GAUGE)
 637         status = bind_xml_read_gauge(doc, child, &value.gauge);
 638       else
 639         status = bind_xml_read_derive(doc, child, &value.derive);
 640       if (status != 0) {
 641         xmlFree(attr_name);
 642         continue;
 643       }
 644
 645       status = (*list_callback)(attr_name, value, current_time, user_data);
 646       if (status == 0)
 647         num_entries++;
 648
 649       xmlFree(attr_name);
 650     }
 651   }
 652
 653   DEBUG("bind plugin: Found %d %s for XPath expression `%s'", num_entries,
 654         (num_entries == 1) ? "entry" : "entries", xpath_expression);
 655
 656   xmlXPathFreeObject(xpathObj);
 657
 658   return 0;
 659 } /* }}} int bind_parse_generic_name_attr_value_list */
 660
 661 static int bind_xml_stats_handle_zone(int version, xmlDoc *doc, /* {{{ */
 662                                       xmlXPathContext *path_ctx, xmlNode *node,
 663                                       cb_view_t *view, time_t current_time) {
 664   char *zone_name = NULL;
 665
 666   if (version >= 3) {
 667     char *n = (char *)xmlGetProp(node, BAD_CAST "name");
 668     char *c = (char *)xmlGetProp(node, BAD_CAST "rdataclass");
 669     if (n && c) {
 670       zone_name = (char *)xmlMalloc(strlen(n) + strlen(c) + 2);
 671       snprintf(zone_name, strlen(n) + strlen(c) + 2, "%s/%s", n, c);
 672     }
 673     xmlFree(n);
 674     xmlFree(c);
 675   } else {
 676     xmlXPathObject *path_obj =
 677         xmlXPathEvalExpression(BAD_CAST "name", path_ctx);
 678     if (path_obj == NULL) {
 679       ERROR("bind plugin: xmlXPathEvalExpression failed.");
 680       return -1;
 681     }
 682
 683     for (int i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr);
 684          i++) {
 685       zone_name = (char *)xmlNodeListGetString(
 686           doc, path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
 687       if (zone_name != NULL)
 688         break;
 689     }
 690     xmlXPathFreeObject(path_obj);
 691   }
 692
 693   if (zone_name == NULL) {
 694     ERROR("bind plugin: Could not determine zone name.");
 695     return -1;
 696   }
 697
 698   size_t j;
 699   for (j = 0; j < view->zones_num; j++) {
 700     if (strcasecmp(zone_name, view->zones[j]) == 0)
 701       break;
 702   }
 703
 704   xmlFree(zone_name);
 705
 706   if (j >= view->zones_num)
 707     return 0;
 708
 709   zone_name = view->zones[j];
 710
 711   DEBUG("bind plugin: bind_xml_stats_handle_zone: Found zone `%s'.", zone_name);
 712
 713   { /* Parse the <counters> tag {{{ */
 714     char plugin_instance[DATA_MAX_NAME_LEN];
 715     translation_table_ptr_t table_ptr = {nsstats_translation_table,
 716                                          nsstats_translation_table_length,
 717                                          plugin_instance};
 718
 719     snprintf(plugin_instance, sizeof(plugin_instance), "%s-zone-%s", view->name,
 720              zone_name);
 721
 722     if (version == 3) {
 723       list_info_ptr_t list_info = {plugin_instance,
 724                                    /* type = */ "dns_qtype"};
 725       bind_parse_generic_name_attr_value_list(
 726           /* xpath = */ "counters[@type='rcode']",
 727           /* callback = */ bind_xml_table_callback,
 728           /* user_data = */ &table_ptr, doc, path_ctx, current_time,
 729           DS_TYPE_COUNTER);
 730       bind_parse_generic_name_attr_value_list(
 731           /* xpath = */ "counters[@type='qtype']",
 732           /* callback = */ bind_xml_list_callback,
 733           /* user_data = */ &list_info, doc, path_ctx, current_time,
 734           DS_TYPE_COUNTER);
 735     } else {
 736       bind_parse_generic_value_list(/* xpath = */ "counters",
 737                                     /* callback = */ bind_xml_table_callback,
 738                                     /* user_data = */ &table_ptr, doc, path_ctx,
 739                                     current_time, DS_TYPE_COUNTER);
 740     }
 741   } /* }}} */
 742
 743   return 0;
 744 } /* }}} int bind_xml_stats_handle_zone */
 745
 746 static int bind_xml_stats_search_zones(int version, xmlDoc *doc, /* {{{ */
 747                                        xmlXPathContext *path_ctx, xmlNode *node,
 748                                        cb_view_t *view, time_t current_time) {
 749   xmlXPathContext *zone_path_context = xmlXPathNewContext(doc);
 750   if (zone_path_context == NULL) {
 751     ERROR("bind plugin: xmlXPathNewContext failed.");
 752     return -1;
 753   }
 754
 755   xmlXPathObject *zone_nodes =
 756       xmlXPathEvalExpression(BAD_CAST "zones/zone", path_ctx);
 757   if (zone_nodes == NULL) {
 758     ERROR("bind plugin: Cannot find any <view> tags.");
 759     xmlXPathFreeContext(zone_path_context);
 760     return -1;
 761   }
 762
 763   for (int i = 0; i < zone_nodes->nodesetval->nodeNr; i++) {
 764     node = zone_nodes->nodesetval->nodeTab[i];
 765     assert(node != NULL);
 766
 767     zone_path_context->node = node;
 768
 769     bind_xml_stats_handle_zone(version, doc, zone_path_context, node, view,
 770                                current_time);
 771   }
 772
 773   xmlXPathFreeObject(zone_nodes);
 774   xmlXPathFreeContext(zone_path_context);
 775   return 0;
 776 } /* }}} int bind_xml_stats_search_zones */
 777
 778 static int bind_xml_stats_handle_view(int version, xmlDoc *doc, /* {{{ */
 779                                       xmlXPathContext *path_ctx, xmlNode *node,
 780                                       time_t current_time) {
 781   char *view_name = NULL;
 782   cb_view_t *view;
 783   size_t j;
 784
 785   if (version == 3) {
 786     view_name = (char *)xmlGetProp(node, BAD_CAST "name");
 787
 788     if (view_name == NULL) {
 789       ERROR("bind plugin: Could not determine view name.");
 790       return -1;
 791     }
 792
 793     for (j = 0; j < views_num; j++) {
 794       if (strcasecmp(view_name, views[j].name) == 0)
 795         break;
 796     }
 797
 798     xmlFree(view_name);
 799     view_name = NULL;
 800   } else {
 801     xmlXPathObject *path_obj =
 802         xmlXPathEvalExpression(BAD_CAST "name", path_ctx);
 803     if (path_obj == NULL) {
 804       ERROR("bind plugin: xmlXPathEvalExpression failed.");
 805       return -1;
 806     }
 807
 808     for (int i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr);
 809          i++) {
 810       view_name = (char *)xmlNodeListGetString(
 811           doc, path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
 812       if (view_name != NULL)
 813         break;
 814     }
 815
 816     if (view_name == NULL) {
 817       ERROR("bind plugin: Could not determine view name.");
 818       xmlXPathFreeObject(path_obj);
 819       return -1;
 820     }
 821
 822     for (j = 0; j < views_num; j++) {
 823       if (strcasecmp(view_name, views[j].name) == 0)
 824         break;
 825     }
 826
 827     xmlFree(view_name);
 828     xmlXPathFreeObject(path_obj);
 829
 830     view_name = NULL;
 831     path_obj = NULL;
 832   }
 833
 834   if (j >= views_num)
 835     return 0;
 836
 837   view = views + j;
 838
 839   DEBUG("bind plugin: bind_xml_stats_handle_view: Found view `%s'.",
 840         view->name);
 841
 842   if (view->qtypes != 0) /* {{{ */
 843   {
 844     char plugin_instance[DATA_MAX_NAME_LEN];
 845     list_info_ptr_t list_info = {plugin_instance,
 846                                  /* type = */ "dns_qtype"};
 847
 848     snprintf(plugin_instance, sizeof(plugin_instance), "%s-qtypes", view->name);
 849     if (version == 3) {
 850       bind_parse_generic_name_attr_value_list(
 851           /* xpath = */ "counters[@type='resqtype']",
 852           /* callback = */ bind_xml_list_callback,
 853           /* user_data = */ &list_info, doc, path_ctx, current_time,
 854           DS_TYPE_COUNTER);
 855     } else {
 856       bind_parse_generic_name_value(/* xpath = */ "rdtype",
 857                                     /* callback = */ bind_xml_list_callback,
 858                                     /* user_data = */ &list_info, doc, path_ctx,
 859                                     current_time, DS_TYPE_COUNTER);
 860     }
 861   } /* }}} */
 862
 863   if (view->resolver_stats != 0) /* {{{ */
 864   {
 865     char plugin_instance[DATA_MAX_NAME_LEN];
 866     translation_table_ptr_t table_ptr = {resstats_translation_table,
 867                                          resstats_translation_table_length,
 868                                          plugin_instance};
 869
 870     snprintf(plugin_instance, sizeof(plugin_instance), "%s-resolver_stats",
 871              view->name);
 872     if (version == 3) {
 873       bind_parse_generic_name_attr_value_list(
 874           "counters[@type='resstats']",
 875           /* callback = */ bind_xml_table_callback,
 876           /* user_data = */ &table_ptr, doc, path_ctx, current_time,
 877           DS_TYPE_COUNTER);
 878     } else {
 879       bind_parse_generic_name_value("resstat",
 880                                     /* callback = */ bind_xml_table_callback,
 881                                     /* user_data = */ &table_ptr, doc, path_ctx,
 882                                     current_time, DS_TYPE_COUNTER);
 883     }
 884   } /* }}} */
 885
 886   /* Record types in the cache */
 887   if (view->cacherrsets != 0) /* {{{ */
 888   {
 889     char plugin_instance[DATA_MAX_NAME_LEN];
 890     list_info_ptr_t list_info = {plugin_instance,
 891                                  /* type = */ "dns_qtype_cached"};
 892
 893     snprintf(plugin_instance, sizeof(plugin_instance), "%s-cache_rr_sets",
 894              view->name);
 895
 896     bind_parse_generic_name_value(/* xpath = */ "cache/rrset",
 897                                   /* callback = */ bind_xml_list_callback,
 898                                   /* user_data = */ &list_info, doc, path_ctx,
 899                                   current_time, DS_TYPE_GAUGE);
 900   } /* }}} */
 901
 902   if (view->zones_num > 0)
 903     bind_xml_stats_search_zones(version, doc, path_ctx, node, view,
 904                                 current_time);
 905
 906   return 0;
 907 } /* }}} int bind_xml_stats_handle_view */
 908
 909 static int bind_xml_stats_search_views(int version, xmlDoc *doc, /* {{{ */
 910                                        xmlXPathContext *xpathCtx,
 911                                        time_t current_time) {
 912   xmlXPathContext *view_path_context = xmlXPathNewContext(doc);
 913   if (view_path_context == NULL) {
 914     ERROR("bind plugin: xmlXPathNewContext failed.");
 915     return -1;
 916   }
 917
 918   xmlXPathObject *view_nodes =
 919       xmlXPathEvalExpression(BAD_CAST "views/view", xpathCtx);
 920   if (view_nodes == NULL) {
 921     ERROR("bind plugin: Cannot find any <view> tags.");
 922     xmlXPathFreeContext(view_path_context);
 923     return -1;
 924   }
 925
 926   for (int i = 0; i < view_nodes->nodesetval->nodeNr; i++) {
 927     xmlNode *node = view_nodes->nodesetval->nodeTab[i];
 928     assert(node != NULL);
 929
 930     view_path_context->node = node;
 931
 932     bind_xml_stats_handle_view(version, doc, view_path_context, node,
 933                                current_time);
 934   }
 935
 936   xmlXPathFreeObject(view_nodes);
 937   xmlXPathFreeContext(view_path_context);
 938   return 0;
 939 } /* }}} int bind_xml_stats_search_views */
 940
 941 static void bind_xml_stats_v3(xmlDoc *doc, /* {{{ */
 942                               xmlXPathContext *xpathCtx, time_t current_time) {
 943   /* XPath:     server/counters[@type='opcode']
 944    * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
 945    * Layout v3:
 946    *   <counters type="opcode">
 947    *     <counter name="A">1</counter>
 948    *     :
 949    *   </counters>
 950    */
 951   if (global_opcodes != 0) {
 952     list_info_ptr_t list_info = {/* plugin instance = */ "global-opcodes",
 953                                  /* type = */ "dns_opcode"};
 954     bind_parse_generic_name_attr_value_list(
 955         /* xpath = */ "server/counters[@type='opcode']",
 956         /* callback = */ bind_xml_list_callback,
 957         /* user_data = */ &list_info, doc, xpathCtx, current_time,
 958         DS_TYPE_COUNTER);
 959   }
 960
 961   /* XPath:     server/counters[@type='qtype']
 962    * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
 963    *            X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
 964    *            SPF, TKEY, IXFR, AXFR, ANY, ..., Others
 965    * Layout v3:
 966    *   <counters type="opcode">
 967    *     <counter name="A">1</counter>
 968    *     :
 969    *   </counters>
 970    */
 971   if (global_qtypes != 0) {
 972     list_info_ptr_t list_info = {/* plugin instance = */ "global-qtypes",
 973                                  /* type = */ "dns_qtype"};
 974
 975     bind_parse_generic_name_attr_value_list(
 976         /* xpath = */ "server/counters[@type='qtype']",
 977         /* callback = */ bind_xml_list_callback,
 978         /* user_data = */ &list_info, doc, xpathCtx, current_time,
 979         DS_TYPE_COUNTER);
 980   }
 981
 982   /* XPath:     server/counters[@type='nsstat']
 983    * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
 984    *            ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
 985    *            UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
 986    *            RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
 987    *            QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
 988    *            QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
 989    *            UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
 990    *            UpdateBadPrereq
 991    * Layout v3:
 992    *   <counters type="nsstat"
 993    *     <counter name="Requestv4">1</counter>
 994    *     <counter name="Requestv6">0</counter>
 995    *     :
 996    *   </counter>
 997    */
 998   if (global_server_stats) {
 999     translation_table_ptr_t table_ptr = {
1000         nsstats_translation_table, nsstats_translation_table_length,
1001         /* plugin_instance = */ "global-server_stats"};
1002
1003     bind_parse_generic_name_attr_value_list(
1004         "server/counters[@type='nsstat']",
1005         /* callback = */ bind_xml_table_callback,
1006         /* user_data = */ &table_ptr, doc, xpathCtx, current_time,
1007         DS_TYPE_COUNTER);
1008   }
1009
1010   /* XPath:     server/zonestats, server/zonestat,
1011    * server/counters[@type='zonestat']
1012    * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
1013    *            SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
1014    *            XfrSuccess, XfrFail
1015    * Layout v3:
1016    *   <counters type="zonestat"
1017    *     <counter name="NotifyOutv4">0</counter>
1018    *     <counter name="NotifyOutv6">0</counter>
1019    *     :
1020    *   </counter>
1021    */
1022   if (global_zone_maint_stats) {
1023     translation_table_ptr_t table_ptr = {
1024         zonestats_translation_table, zonestats_translation_table_length,
1025         /* plugin_instance = */ "global-zone_maint_stats"};
1026
1027     bind_parse_generic_name_attr_value_list(
1028         "server/counters[@type='zonestat']",
1029         /* callback = */ bind_xml_table_callback,
1030         /* user_data = */ &table_ptr, doc, xpathCtx, current_time,
1031         DS_TYPE_COUNTER);
1032   }
1033
1034   /* XPath:     server/resstats, server/counters[@type='resstat']
1035    * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1036    *            FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1037    *            Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1038    *            GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1039    * Layout v3:
1040    *   <counters type="resstat"
1041    *     <counter name="Queryv4">0</counter>
1042    *     <counter name="Queryv6">0</counter>
1043    *     :
1044    *   </counter>
1045    */
1046   if (global_resolver_stats != 0) {
1047     translation_table_ptr_t table_ptr = {
1048         resstats_translation_table, resstats_translation_table_length,
1049         /* plugin_instance = */ "global-resolver_stats"};
1050
1051     bind_parse_generic_name_attr_value_list(
1052         "server/counters[@type='resstat']",
1053         /* callback = */ bind_xml_table_callback,
1054         /* user_data = */ &table_ptr, doc, xpathCtx, current_time,
1055         DS_TYPE_COUNTER);
1056   }
1057 } /* }}} bind_xml_stats_v3 */
1058
1059 static void bind_xml_stats_v1_v2(int version, xmlDoc *doc, /* {{{ */
1060                                  xmlXPathContext *xpathCtx,
1061                                  time_t current_time) {
1062   /* XPath:     server/requests/opcode, server/counters[@type='opcode']
1063    * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
1064    * Layout V1 and V2:
1065    *   <opcode>
1066    *     <name>A</name>
1067    *     <counter>1</counter>
1068    *   </opcode>
1069    *   :
1070    */
1071   if (global_opcodes != 0) {
1072     list_info_ptr_t list_info = {/* plugin instance = */ "global-opcodes",
1073                                  /* type = */ "dns_opcode"};
1074
1075     bind_parse_generic_name_value(/* xpath = */ "server/requests/opcode",
1076                                   /* callback = */ bind_xml_list_callback,
1077                                   /* user_data = */ &list_info, doc, xpathCtx,
1078                                   current_time, DS_TYPE_COUNTER);
1079   }
1080
1081   /* XPath:     server/queries-in/rdtype, server/counters[@type='qtype']
1082    * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
1083    *            X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
1084    *            SPF, TKEY, IXFR, AXFR, ANY, ..., Others
1085    * Layout v1 or v2:
1086    *   <rdtype>
1087    *     <name>A</name>
1088    *     <counter>1</counter>
1089    *   </rdtype>
1090    *   :
1091    */
1092   if (global_qtypes != 0) {
1093     list_info_ptr_t list_info = {/* plugin instance = */ "global-qtypes",
1094                                  /* type = */ "dns_qtype"};
1095
1096     bind_parse_generic_name_value(/* xpath = */ "server/queries-in/rdtype",
1097                                   /* callback = */ bind_xml_list_callback,
1098                                   /* user_data = */ &list_info, doc, xpathCtx,
1099                                   current_time, DS_TYPE_COUNTER);
1100   }
1101
1102   /* XPath:     server/nsstats, server/nsstat, server/counters[@type='nsstat']
1103    * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
1104    *            ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
1105    *            UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
1106    *            RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
1107    *            QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
1108    *            QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
1109    *            UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
1110    *            UpdateBadPrereq
1111    * Layout v1:
1112    *   <nsstats>
1113    *     <Requestv4>1</Requestv4>
1114    *     <Requestv6>0</Requestv6>
1115    *     :
1116    *   </nsstats>
1117    * Layout v2:
1118    *   <nsstat>
1119    *     <name>Requestv4</name>
1120    *     <counter>1</counter>
1121    *   </nsstat>
1122    *   <nsstat>
1123    *     <name>Requestv6</name>
1124    *     <counter>0</counter>
1125    *   </nsstat>
1126    *   :
1127    */
1128   if (global_server_stats) {
1129     translation_table_ptr_t table_ptr = {
1130         nsstats_translation_table, nsstats_translation_table_length,
1131         /* plugin_instance = */ "global-server_stats"};
1132
1133     if (version == 1) {
1134       bind_parse_generic_value_list("server/nsstats",
1135                                     /* callback = */ bind_xml_table_callback,
1136                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1137                                     current_time, DS_TYPE_COUNTER);
1138     } else {
1139       bind_parse_generic_name_value("server/nsstat",
1140                                     /* callback = */ bind_xml_table_callback,
1141                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1142                                     current_time, DS_TYPE_COUNTER);
1143     }
1144   }
1145
1146   /* XPath:     server/zonestats, server/zonestat,
1147    * server/counters[@type='zonestat']
1148    * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
1149    *            SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
1150    *            XfrSuccess, XfrFail
1151    * Layout v1:
1152    *   <zonestats>
1153    *     <NotifyOutv4>0</NotifyOutv4>
1154    *     <NotifyOutv6>0</NotifyOutv6>
1155    *     :
1156    *   </zonestats>
1157    * Layout v2:
1158    *   <zonestat>
1159    *     <name>NotifyOutv4</name>
1160    *     <counter>0</counter>
1161    *   </zonestat>
1162    *   <zonestat>
1163    *     <name>NotifyOutv6</name>
1164    *     <counter>0</counter>
1165    *   </zonestat>
1166    *   :
1167    */
1168   if (global_zone_maint_stats) {
1169     translation_table_ptr_t table_ptr = {
1170         zonestats_translation_table, zonestats_translation_table_length,
1171         /* plugin_instance = */ "global-zone_maint_stats"};
1172
1173     if (version == 1) {
1174       bind_parse_generic_value_list("server/zonestats",
1175                                     /* callback = */ bind_xml_table_callback,
1176                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1177                                     current_time, DS_TYPE_COUNTER);
1178     } else {
1179       bind_parse_generic_name_value("server/zonestat",
1180                                     /* callback = */ bind_xml_table_callback,
1181                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1182                                     current_time, DS_TYPE_COUNTER);
1183     }
1184   }
1185
1186   /* XPath:     server/resstats, server/counters[@type='resstat']
1187    * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1188    *            FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1189    *            Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1190    *            GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1191    * Layout v1:
1192    *   <resstats>
1193    *     <Queryv4>0</Queryv4>
1194    *     <Queryv6>0</Queryv6>
1195    *     :
1196    *   </resstats>
1197    * Layout v2:
1198    *   <resstat>
1199    *     <name>Queryv4</name>
1200    *     <counter>0</counter>
1201    *   </resstat>
1202    *   <resstat>
1203    *     <name>Queryv6</name>
1204    *     <counter>0</counter>
1205    *   </resstat>
1206    *   :
1207    */
1208   if (global_resolver_stats != 0) {
1209     translation_table_ptr_t table_ptr = {
1210         resstats_translation_table, resstats_translation_table_length,
1211         /* plugin_instance = */ "global-resolver_stats"};
1212
1213     if (version == 1) {
1214       bind_parse_generic_value_list("server/resstats",
1215                                     /* callback = */ bind_xml_table_callback,
1216                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1217                                     current_time, DS_TYPE_COUNTER);
1218     } else {
1219       bind_parse_generic_name_value("server/resstat",
1220                                     /* callback = */ bind_xml_table_callback,
1221                                     /* user_data = */ &table_ptr, doc, xpathCtx,
1222                                     current_time, DS_TYPE_COUNTER);
1223     }
1224   }
1225 } /* }}} bind_xml_stats_v1_v2 */
1226
1227 static int bind_xml_stats(int version, xmlDoc *doc, /* {{{ */
1228                           xmlXPathContext *xpathCtx, xmlNode *statsnode) {
1229   time_t current_time = 0;
1230
1231   xpathCtx->node = statsnode;
1232
1233   /* TODO: Check `server/boot-time' to recognize server restarts. */
1234
1235   int status = bind_xml_read_timestamp("server/current-time", doc, xpathCtx,
1236                                        &current_time);
1237   if (status != 0) {
1238     ERROR("bind plugin: Reading `server/current-time' failed.");
1239     return -1;
1240   }
1241   DEBUG("bind plugin: Current server time is %i.", (int)current_time);
1242
1243   if (version == 3) {
1244     bind_xml_stats_v3(doc, xpathCtx, current_time);
1245   } else {
1246     bind_xml_stats_v1_v2(version, doc, xpathCtx, current_time);
1247   }
1248
1249   /* XPath:  memory/summary
1250    * Variables: TotalUse, InUse, BlockSize, ContextSize, Lost
1251    * Layout: v2 and v3:
1252    *   <summary>
1253    *     <TotalUse>6587096</TotalUse>
1254    *     <InUse>1345424</InUse>
1255    *     <BlockSize>5505024</BlockSize>
1256    *     <ContextSize>3732456</ContextSize>
1257    *     <Lost>0</Lost>
1258    *   </summary>
1259    */
1260   if (global_memory_stats != 0) {
1261     translation_table_ptr_t table_ptr = {
1262         memsummary_translation_table, memsummary_translation_table_length,
1263         /* plugin_instance = */ "global-memory_stats"};
1264
1265     bind_parse_generic_value_list("memory/summary",
1266                                   /* callback = */ bind_xml_table_callback,
1267                                   /* user_data = */ &table_ptr, doc, xpathCtx,
1268                                   current_time, DS_TYPE_GAUGE);
1269   }
1270
1271   if (views_num > 0)
1272     bind_xml_stats_search_views(version, doc, xpathCtx, current_time);
1273
1274   return 0;
1275 } /* }}} int bind_xml_stats */
1276
1277 static int bind_xml(const char *data) /* {{{ */
1278 {
1279   int ret = -1;
1280
1281   xmlDoc *doc = xmlParseMemory(data, strlen(data));
1282   if (doc == NULL) {
1283     ERROR("bind plugin: xmlParseMemory failed.");
1284     return -1;
1285   }
1286
1287   xmlXPathContext *xpathCtx = xmlXPathNewContext(doc);
1288   if (xpathCtx == NULL) {
1289     ERROR("bind plugin: xmlXPathNewContext failed.");
1290     xmlFreeDoc(doc);
1291     return -1;
1292   }
1293
1294   //
1295   // version 3.* of statistics XML (since BIND9.9)
1296   //
1297
1298   xmlXPathObject *xpathObj =
1299       xmlXPathEvalExpression(BAD_CAST "/statistics", xpathCtx);
1300   if (xpathObj == NULL || xpathObj->nodesetval == NULL ||
1301       xpathObj->nodesetval->nodeNr == 0) {
1302     DEBUG("bind plugin: Statistics appears not to be v3");
1303     // we will fallback to v1 or v2 detection
1304     if (xpathObj != NULL) {
1305       xmlXPathFreeObject(xpathObj);
1306     }
1307   } else {
1308     for (int i = 0; i < xpathObj->nodesetval->nodeNr; i++) {
1309       xmlNode *node;
1310       char *attr_version;
1311
1312       node = xpathObj->nodesetval->nodeTab[i];
1313       assert(node != NULL);
1314
1315       attr_version = (char *)xmlGetProp(node, BAD_CAST "version");
1316       if (attr_version == NULL) {
1317         NOTICE("bind plugin: Found <statistics> tag doesn't have a "
1318                "`version' attribute.");
1319         continue;
1320       }
1321       DEBUG("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1322
1323       if (strncmp("3.", attr_version, strlen("3.")) != 0) {
1324         /* TODO: Use the complaint mechanism here. */
1325         NOTICE("bind plugin: Found <statistics> tag with version `%s'. "
1326                "Unfortunately I have no clue how to parse that. "
1327                "Please open a bug report for this.",
1328                attr_version);
1329         xmlFree(attr_version);
1330         continue;
1331       }
1332       ret = bind_xml_stats(3, doc, xpathCtx, node);
1333
1334       xmlFree(attr_version);
1335       /* One <statistics> node ought to be enough. */
1336       break;
1337     }
1338
1339     // we are finished, early-return
1340     xmlXPathFreeObject(xpathObj);
1341     xmlXPathFreeContext(xpathCtx);
1342     xmlFreeDoc(doc);
1343
1344     return ret;
1345   }
1346
1347   //
1348   // versions 1.* or 2.* of statistics XML
1349   //
1350
1351   xpathObj = xmlXPathEvalExpression(BAD_CAST "/isc/bind/statistics", xpathCtx);
1352   if (xpathObj == NULL) {
1353     ERROR("bind plugin: Cannot find the <statistics> tag.");
1354     xmlXPathFreeContext(xpathCtx);
1355     xmlFreeDoc(doc);
1356     return -1;
1357   } else if (xpathObj->nodesetval == NULL) {
1358     ERROR("bind plugin: xmlXPathEvalExpression failed.");
1359     xmlXPathFreeObject(xpathObj);
1360     xmlXPathFreeContext(xpathCtx);
1361     xmlFreeDoc(doc);
1362     return -1;
1363   }
1364
1365   for (int i = 0; i < xpathObj->nodesetval->nodeNr; i++) {
1366     xmlNode *node;
1367     char *attr_version;
1368     int parsed_version = 0;
1369
1370     node = xpathObj->nodesetval->nodeTab[i];
1371     assert(node != NULL);
1372
1373     attr_version = (char *)xmlGetProp(node, BAD_CAST "version");
1374     if (attr_version == NULL) {
1375       NOTICE("bind plugin: Found <statistics> tag doesn't have a "
1376              "`version' attribute.");
1377       continue;
1378     }
1379     DEBUG("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1380
1381     /* At the time this plugin was written, version "1.0" was used by
1382      * BIND 9.5.0, version "2.0" was used by BIND 9.5.1 and 9.6.0. We assume
1383      * that "1.*" and "2.*" don't introduce structural changes, so we just
1384      * check for the first two characters here. */
1385     if (strncmp("1.", attr_version, strlen("1.")) == 0)
1386       parsed_version = 1;
1387     else if (strncmp("2.", attr_version, strlen("2.")) == 0)
1388       parsed_version = 2;
1389     else {
1390       /* TODO: Use the complaint mechanism here. */
1391       NOTICE("bind plugin: Found <statistics> tag with version `%s'. "
1392              "Unfortunately I have no clue how to parse that. "
1393              "Please open a bug report for this.",
1394              attr_version);
1395       xmlFree(attr_version);
1396       continue;
1397     }
1398
1399     ret = bind_xml_stats(parsed_version, doc, xpathCtx, node);
1400
1401     xmlFree(attr_version);
1402     /* One <statistics> node ought to be enough. */
1403     break;
1404   }
1405
1406   xmlXPathFreeObject(xpathObj);
1407   xmlXPathFreeContext(xpathCtx);
1408   xmlFreeDoc(doc);
1409
1410   return ret;
1411 } /* }}} int bind_xml */
1412
1413 static int bind_config_set_bool(const char *name, int *var, /* {{{ */
1414                                 oconfig_item_t *ci) {
1415   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)) {
1416     WARNING("bind plugin: The `%s' option needs "
1417             "exactly one boolean argument.",
1418             name);
1419     return -1;
1420   }
1421
1422   if (ci->values[0].value.boolean)
1423     *var = 1;
1424   else
1425     *var = 0;
1426   return 0;
1427 } /* }}} int bind_config_set_bool */
1428
1429 static int bind_config_add_view_zone(cb_view_t *view, /* {{{ */
1430                                      oconfig_item_t *ci) {
1431   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1432     WARNING("bind plugin: The `Zone' option needs "
1433             "exactly one string argument.");
1434     return -1;
1435   }
1436
1437   char **tmp = realloc(view->zones, sizeof(char *) * (view->zones_num + 1));
1438   if (tmp == NULL) {
1439     ERROR("bind plugin: realloc failed.");
1440     return -1;
1441   }
1442   view->zones = tmp;
1443
1444   view->zones[view->zones_num] = strdup(ci->values[0].value.string);
1445   if (view->zones[view->zones_num] == NULL) {
1446     ERROR("bind plugin: strdup failed.");
1447     return -1;
1448   }
1449   view->zones_num++;
1450
1451   return 0;
1452 } /* }}} int bind_config_add_view_zone */
1453
1454 static int bind_config_add_view(oconfig_item_t *ci) /* {{{ */
1455 {
1456   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
1457     WARNING("bind plugin: `View' blocks need exactly one string argument.");
1458     return -1;
1459   }
1460
1461   cb_view_t *tmp = realloc(views, sizeof(*views) * (views_num + 1));
1462   if (tmp == NULL) {
1463     ERROR("bind plugin: realloc failed.");
1464     return -1;
1465   }
1466   views = tmp;
1467   tmp = views + views_num;
1468
1469   memset(tmp, 0, sizeof(*tmp));
1470   tmp->qtypes = 1;
1471   tmp->resolver_stats = 1;
1472   tmp->cacherrsets = 1;
1473   tmp->zones = NULL;
1474   tmp->zones_num = 0;
1475
1476   tmp->name = strdup(ci->values[0].value.string);
1477   if (tmp->name == NULL) {
1478     ERROR("bind plugin: strdup failed.");
1479     sfree(views);
1480     return -1;
1481   }
1482
1483   for (int i = 0; i < ci->children_num; i++) {
1484     oconfig_item_t *child = ci->children + i;
1485
1486     if (strcasecmp("QTypes", child->key) == 0)
1487       bind_config_set_bool("QTypes", &tmp->qtypes, child);
1488     else if (strcasecmp("ResolverStats", child->key) == 0)
1489       bind_config_set_bool("ResolverStats", &tmp->resolver_stats, child);
1490     else if (strcasecmp("CacheRRSets", child->key) == 0)
1491       bind_config_set_bool("CacheRRSets", &tmp->cacherrsets, child);
1492     else if (strcasecmp("Zone", child->key) == 0)
1493       bind_config_add_view_zone(tmp, child);
1494     else {
1495       WARNING("bind plugin: Unknown configuration option "
1496               "`%s' in view `%s' will be ignored.",
1497               child->key, tmp->name);
1498     }
1499   } /* for (i = 0; i < ci->children_num; i++) */
1500
1501   views_num++;
1502   return 0;
1503 } /* }}} int bind_config_add_view */
1504
1505 static int bind_config(oconfig_item_t *ci) /* {{{ */
1506 {
1507   for (int i = 0; i < ci->children_num; i++) {
1508     oconfig_item_t *child = ci->children + i;
1509
1510     if (strcasecmp("Url", child->key) == 0) {
1511       if ((child->values_num != 1) ||
1512           (child->values[0].type != OCONFIG_TYPE_STRING)) {
1513         WARNING("bind plugin: The `Url' option needs "
1514                 "exactly one string argument.");
1515         return -1;
1516       }
1517
1518       sfree(url);
1519       url = strdup(child->values[0].value.string);
1520     } else if (strcasecmp("OpCodes", child->key) == 0)
1521       bind_config_set_bool("OpCodes", &global_opcodes, child);
1522     else if (strcasecmp("QTypes", child->key) == 0)
1523       bind_config_set_bool("QTypes", &global_qtypes, child);
1524     else if (strcasecmp("ServerStats", child->key) == 0)
1525       bind_config_set_bool("ServerStats", &global_server_stats, child);
1526     else if (strcasecmp("ZoneMaintStats", child->key) == 0)
1527       bind_config_set_bool("ZoneMaintStats", &global_zone_maint_stats, child);
1528     else if (strcasecmp("ResolverStats", child->key) == 0)
1529       bind_config_set_bool("ResolverStats", &global_resolver_stats, child);
1530     else if (strcasecmp("MemoryStats", child->key) == 0)
1531       bind_config_set_bool("MemoryStats", &global_memory_stats, child);
1532     else if (strcasecmp("View", child->key) == 0)
1533       bind_config_add_view(child);
1534     else if (strcasecmp("ParseTime", child->key) == 0)
1535       cf_util_get_boolean(child, &config_parse_time);
1536     else if (strcasecmp("Timeout", child->key) == 0)
1537       cf_util_get_int(child, &timeout);
1538     else {
1539       WARNING("bind plugin: Unknown configuration option "
1540               "`%s' will be ignored.",
1541               child->key);
1542     }
1543   }
1544
1545   return 0;
1546 } /* }}} int bind_config */
1547
1548 static int bind_init(void) /* {{{ */
1549 {
1550   if (curl != NULL)
1551     return 0;
1552
1553   curl = curl_easy_init();
1554   if (curl == NULL) {
1555     ERROR("bind plugin: bind_init: curl_easy_init failed.");
1556     return -1;
1557   }
1558
1559   curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1L);
1560   curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, bind_curl_callback);
1561   curl_easy_setopt(curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
1562   curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, bind_curl_error);
1563   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
1564   curl_easy_setopt(curl, CURLOPT_MAXREDIRS, 50L);
1565 #ifdef HAVE_CURLOPT_TIMEOUT_MS
1566   curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS,
1567                    (timeout >= 0) ? (long)timeout : (long)CDTIME_T_TO_MS(
1568                                                         plugin_get_interval()));
1569 #endif
1570
1571   return 0;
1572 } /* }}} int bind_init */
1573
1574 static int bind_read(void) /* {{{ */
1575 {
1576   if (curl == NULL) {
1577     ERROR("bind plugin: I don't have a CURL object.");
1578     return -1;
1579   }
1580
1581   bind_buffer_fill = 0;
1582
1583   curl_easy_setopt(curl, CURLOPT_URL, (url != NULL) ? url : BIND_DEFAULT_URL);
1584
1585   if (curl_easy_perform(curl) != CURLE_OK) {
1586     ERROR("bind plugin: curl_easy_perform failed: %s", bind_curl_error);
1587     return -1;
1588   }
1589
1590   int status = bind_xml(bind_buffer);
1591   if (status != 0)
1592     return -1;
1593   else
1594     return 0;
1595 } /* }}} int bind_read */
1596
1597 static int bind_shutdown(void) /* {{{ */
1598 {
1599   if (curl != NULL) {
1600     curl_easy_cleanup(curl);
1601     curl = NULL;
1602   }
1603
1604   return 0;
1605 } /* }}} int bind_shutdown */
1606
1607 void module_register(void) {
1608   plugin_register_complex_config("bind", bind_config);
1609   plugin_register_init("bind", bind_init);
1610   plugin_register_read("bind", bind_read);
1611   plugin_register_shutdown("bind", bind_shutdown);
1612 } /* void module_register */