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