2 * collectd - src/libvirt.c
3 * Copyright (C) 2006-2008 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the license is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Richard W.M. Jones <rjones@redhat.com>
25 #include "configfile.h"
26 #include "utils_ignorelist.h"
27 #include "utils_complain.h"
29 #include <libvirt/libvirt.h>
30 #include <libvirt/virterror.h>
31 #include <libxml/parser.h>
32 #include <libxml/tree.h>
33 #include <libxml/xpath.h>
35 static const char *config_keys[] = {
50 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
53 static virConnectPtr conn = 0;
54 static char *conn_string = NULL;
55 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
57 /* Seconds between list refreshes, 0 disables completely. */
58 static int interval = 60;
60 /* List of domains, if specified. */
61 static ignorelist_t *il_domains = NULL;
62 /* List of block devices, if specified. */
63 static ignorelist_t *il_block_devices = NULL;
64 /* List of network interface devices, if specified. */
65 static ignorelist_t *il_interface_devices = NULL;
67 static int ignore_device_match (ignorelist_t *,
68 const char *domname, const char *devpath);
70 /* Actual list of domains found on last refresh. */
71 static virDomainPtr *domains = NULL;
72 static int nr_domains = 0;
74 static void free_domains (void);
75 static int add_domain (virDomainPtr dom);
77 /* Actual list of block devices found on last refresh. */
79 virDomainPtr dom; /* domain */
80 char *path; /* name of block device */
83 static struct block_device *block_devices = NULL;
84 static int nr_block_devices = 0;
86 static void free_block_devices (void);
87 static int add_block_device (virDomainPtr dom, const char *path);
89 /* Actual list of network interfaces found on last refresh. */
90 struct interface_device {
91 virDomainPtr dom; /* domain */
92 char *path; /* name of interface device */
93 char *address; /* mac address of interface device */
94 char *number; /* interface device number */
97 static struct interface_device *interface_devices = NULL;
98 static int nr_interface_devices = 0;
100 static void free_interface_devices (void);
101 static int add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number);
103 /* HostnameFormat. */
104 #define HF_MAX_FIELDS 3
113 static enum hf_field hostname_format[HF_MAX_FIELDS] =
116 /* InterfaceFormat. */
123 static enum if_field interface_format = if_name;
125 /* Time that we last refreshed. */
126 static time_t last_refresh = (time_t) 0;
128 static int refresh_lists (void);
130 /* ERROR(...) macro for virterrors. */
131 #define VIRT_ERROR(conn,s) do { \
133 err = (conn) ? virConnGetLastError ((conn)) : virGetLastError (); \
134 if (err) ERROR ("%s: %s", (s), err->message); \
138 init_value_list (value_list_t *vl, virDomainPtr dom)
142 char uuid[VIR_UUID_STRING_BUFLEN];
144 sstrncpy (vl->plugin, "libvirt", sizeof (vl->plugin));
148 /* Construct the hostname field according to HostnameFormat. */
149 for (i = 0; i < HF_MAX_FIELDS; ++i) {
150 if (hostname_format[i] == hf_none)
153 n = DATA_MAX_NAME_LEN - strlen (vl->host) - 2;
155 if (i > 0 && n >= 1) {
156 strncat (vl->host, ":", 1);
160 switch (hostname_format[i]) {
163 strncat (vl->host, hostname_g, n);
166 name = virDomainGetName (dom);
168 strncat (vl->host, name, n);
171 if (virDomainGetUUIDString (dom, uuid) == 0)
172 strncat (vl->host, uuid, n);
177 vl->host[sizeof (vl->host) - 1] = '\0';
178 } /* void init_value_list */
181 cpu_submit (unsigned long long cpu_time,
182 virDomainPtr dom, const char *type)
185 value_list_t vl = VALUE_LIST_INIT;
187 init_value_list (&vl, dom);
189 values[0].derive = cpu_time;
194 sstrncpy (vl.type, type, sizeof (vl.type));
196 plugin_dispatch_values (&vl);
200 vcpu_submit (derive_t cpu_time,
201 virDomainPtr dom, int vcpu_nr, const char *type)
204 value_list_t vl = VALUE_LIST_INIT;
206 init_value_list (&vl, dom);
208 values[0].derive = cpu_time;
212 sstrncpy (vl.type, type, sizeof (vl.type));
213 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%d", vcpu_nr);
215 plugin_dispatch_values (&vl);
219 submit_derive2 (const char *type, derive_t v0, derive_t v1,
220 virDomainPtr dom, const char *devname)
223 value_list_t vl = VALUE_LIST_INIT;
225 init_value_list (&vl, dom);
227 values[0].derive = v0;
228 values[1].derive = v1;
232 sstrncpy (vl.type, type, sizeof (vl.type));
233 sstrncpy (vl.type_instance, devname, sizeof (vl.type_instance));
235 plugin_dispatch_values (&vl);
236 } /* void submit_derive2 */
241 if (virInitialize () != 0)
248 lv_config (const char *key, const char *value)
250 if (virInitialize () != 0)
253 if (il_domains == NULL)
254 il_domains = ignorelist_create (1);
255 if (il_block_devices == NULL)
256 il_block_devices = ignorelist_create (1);
257 if (il_interface_devices == NULL)
258 il_interface_devices = ignorelist_create (1);
260 if (strcasecmp (key, "Connection") == 0) {
261 char *tmp = strdup (value);
263 ERROR ("libvirt plugin: Connection strdup failed.");
271 if (strcasecmp (key, "RefreshInterval") == 0) {
273 interval = strtol (value, &eptr, 10);
274 if (eptr == NULL || *eptr != '\0') return 1;
278 if (strcasecmp (key, "Domain") == 0) {
279 if (ignorelist_add (il_domains, value)) return 1;
282 if (strcasecmp (key, "BlockDevice") == 0) {
283 if (ignorelist_add (il_block_devices, value)) return 1;
286 if (strcasecmp (key, "InterfaceDevice") == 0) {
287 if (ignorelist_add (il_interface_devices, value)) return 1;
291 if (strcasecmp (key, "IgnoreSelected") == 0) {
294 ignorelist_set_invert (il_domains, 0);
295 ignorelist_set_invert (il_block_devices, 0);
296 ignorelist_set_invert (il_interface_devices, 0);
300 ignorelist_set_invert (il_domains, 1);
301 ignorelist_set_invert (il_block_devices, 1);
302 ignorelist_set_invert (il_interface_devices, 1);
307 if (strcasecmp (key, "HostnameFormat") == 0) {
309 char *fields[HF_MAX_FIELDS];
312 value_copy = strdup (value);
313 if (value_copy == NULL) {
314 ERROR ("libvirt plugin: strdup failed.");
318 n = strsplit (value_copy, fields, HF_MAX_FIELDS);
321 ERROR ("HostnameFormat: no fields");
325 for (i = 0; i < n; ++i) {
326 if (strcasecmp (fields[i], "hostname") == 0)
327 hostname_format[i] = hf_hostname;
328 else if (strcasecmp (fields[i], "name") == 0)
329 hostname_format[i] = hf_name;
330 else if (strcasecmp (fields[i], "uuid") == 0)
331 hostname_format[i] = hf_uuid;
334 ERROR ("unknown HostnameFormat field: %s", fields[i]);
340 for (i = n; i < HF_MAX_FIELDS; ++i)
341 hostname_format[i] = hf_none;
346 if (strcasecmp (key, "InterfaceFormat") == 0) {
347 if (strcasecmp (value, "name") == 0)
348 interface_format = if_name;
349 else if (strcasecmp (value, "address") == 0)
350 interface_format = if_address;
351 else if (strcasecmp (value, "number") == 0)
352 interface_format = if_number;
354 ERROR ("unknown InterfaceFormat: %s", value);
360 /* Unrecognised option. */
371 /* `conn_string == NULL' is acceptable. */
372 conn = virConnectOpenReadOnly (conn_string);
374 c_complain (LOG_ERR, &conn_complain,
375 "libvirt plugin: Unable to connect: "
376 "virConnectOpenReadOnly failed.");
380 c_release (LOG_NOTICE, &conn_complain,
381 "libvirt plugin: Connection established.");
385 /* Need to refresh domain or device lists? */
386 if ((last_refresh == (time_t) 0) ||
387 ((interval > 0) && ((last_refresh + interval) <= t))) {
388 if (refresh_lists () != 0) {
390 virConnectClose (conn);
398 for (i = 0; i < nr_domains; ++i)
399 fprintf (stderr, "domain %s\n", virDomainGetName (domains[i]));
400 for (i = 0; i < nr_block_devices; ++i)
401 fprintf (stderr, "block device %d %s:%s\n",
402 i, virDomainGetName (block_devices[i].dom),
403 block_devices[i].path);
404 for (i = 0; i < nr_interface_devices; ++i)
405 fprintf (stderr, "interface device %d %s:%s\n",
406 i, virDomainGetName (interface_devices[i].dom),
407 interface_devices[i].path);
410 /* Get CPU usage, VCPU usage for each domain. */
411 for (i = 0; i < nr_domains; ++i) {
413 virVcpuInfoPtr vinfo = NULL;
417 status = virDomainGetInfo (domains[i], &info);
420 ERROR ("libvirt plugin: virDomainGetInfo failed with status %i.",
425 cpu_submit (info.cpuTime, domains[i], "virt_cpu_total");
427 vinfo = malloc (info.nrVirtCpu * sizeof (vinfo[0]));
429 ERROR ("libvirt plugin: malloc failed.");
433 status = virDomainGetVcpus (domains[i], vinfo, info.nrVirtCpu,
434 /* cpu map = */ NULL, /* cpu map length = */ 0);
437 ERROR ("libvirt plugin: virDomainGetVcpus failed with status %i.",
443 for (j = 0; j < info.nrVirtCpu; ++j)
444 vcpu_submit (vinfo[j].cpuTime,
445 domains[i], vinfo[j].number, "virt_vcpu");
450 /* Get block device stats for each domain. */
451 for (i = 0; i < nr_block_devices; ++i) {
452 struct _virDomainBlockStats stats;
454 if (virDomainBlockStats (block_devices[i].dom, block_devices[i].path,
455 &stats, sizeof stats) != 0)
458 if ((stats.rd_req != -1) && (stats.wr_req != -1))
459 submit_derive2 ("disk_ops",
460 (derive_t) stats.rd_req, (derive_t) stats.wr_req,
461 block_devices[i].dom, block_devices[i].path);
463 if ((stats.rd_bytes != -1) && (stats.wr_bytes != -1))
464 submit_derive2 ("disk_octets",
465 (derive_t) stats.rd_bytes, (derive_t) stats.wr_bytes,
466 block_devices[i].dom, block_devices[i].path);
467 } /* for (nr_block_devices) */
469 /* Get interface stats for each domain. */
470 for (i = 0; i < nr_interface_devices; ++i) {
471 struct _virDomainInterfaceStats stats;
472 char *display_name = NULL;
475 switch (interface_format) {
477 display_name = interface_devices[i].address;
480 display_name = interface_devices[i].number;
484 display_name = interface_devices[i].path;
487 if (virDomainInterfaceStats (interface_devices[i].dom,
488 interface_devices[i].path,
489 &stats, sizeof stats) != 0)
492 if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
493 submit_derive2 ("if_octets",
494 (derive_t) stats.rx_bytes, (derive_t) stats.tx_bytes,
495 interface_devices[i].dom, display_name);
497 if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
498 submit_derive2 ("if_packets",
499 (derive_t) stats.rx_packets, (derive_t) stats.tx_packets,
500 interface_devices[i].dom, display_name);
502 if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
503 submit_derive2 ("if_errors",
504 (derive_t) stats.rx_errs, (derive_t) stats.tx_errs,
505 interface_devices[i].dom, display_name);
507 if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
508 submit_derive2 ("if_dropped",
509 (derive_t) stats.rx_drop, (derive_t) stats.tx_drop,
510 interface_devices[i].dom, display_name);
511 } /* for (nr_interface_devices) */
521 n = virConnectNumOfDomains (conn);
523 VIRT_ERROR (conn, "reading number of domains");
531 /* Get list of domains. */
532 domids = malloc (sizeof (int) * n);
534 ERROR ("libvirt plugin: malloc failed.");
538 n = virConnectListDomains (conn, domids, n);
540 VIRT_ERROR (conn, "reading list of domains");
545 free_block_devices ();
546 free_interface_devices ();
549 /* Fetch each domain and add it to the list, unless ignore. */
550 for (i = 0; i < n; ++i) {
551 virDomainPtr dom = NULL;
554 xmlDocPtr xml_doc = NULL;
555 xmlXPathContextPtr xpath_ctx = NULL;
556 xmlXPathObjectPtr xpath_obj = NULL;
559 dom = virDomainLookupByID (conn, domids[i]);
561 VIRT_ERROR (conn, "virDomainLookupByID");
562 /* Could be that the domain went away -- ignore it anyway. */
566 name = virDomainGetName (dom);
568 VIRT_ERROR (conn, "virDomainGetName");
572 if (il_domains && ignorelist_match (il_domains, name) != 0)
575 if (add_domain (dom) < 0) {
576 ERROR ("libvirt plugin: malloc failed.");
580 /* Get a list of devices for this domain. */
581 xml = virDomainGetXMLDesc (dom, 0);
583 VIRT_ERROR (conn, "virDomainGetXMLDesc");
587 /* Yuck, XML. Parse out the devices. */
588 xml_doc = xmlReadDoc ((xmlChar *) xml, NULL, NULL, XML_PARSE_NONET);
589 if (xml_doc == NULL) {
590 VIRT_ERROR (conn, "xmlReadDoc");
594 xpath_ctx = xmlXPathNewContext (xml_doc);
597 xpath_obj = xmlXPathEval
598 ((xmlChar *) "/domain/devices/disk/target[@dev]",
600 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
601 xpath_obj->nodesetval == NULL)
604 for (j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
608 node = xpath_obj->nodesetval->nodeTab[j];
610 path = (char *) xmlGetProp (node, (xmlChar *) "dev");
613 if (il_block_devices &&
614 ignore_device_match (il_block_devices, name, path) != 0)
617 add_block_device (dom, path);
619 if (path) xmlFree (path);
621 xmlXPathFreeObject (xpath_obj);
623 /* Network interfaces. */
624 xpath_obj = xmlXPathEval
625 ((xmlChar *) "/domain/devices/interface[target[@dev]]",
627 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
628 xpath_obj->nodesetval == NULL)
631 xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
633 for (j = 0; j < xml_interfaces->nodeNr; ++j) {
635 char *address = NULL;
636 xmlNodePtr xml_interface;
638 xml_interface = xml_interfaces->nodeTab[j];
639 if (!xml_interface) continue;
640 xmlNodePtr child = NULL;
642 for (child = xml_interface->children; child; child = child->next) {
643 if (child->type != XML_ELEMENT_NODE) continue;
645 if (xmlStrEqual(child->name, (const xmlChar *) "target")) {
646 path = (char *) xmlGetProp (child, (const xmlChar *) "dev");
648 } else if (xmlStrEqual(child->name, (const xmlChar *) "mac")) {
649 address = (char *) xmlGetProp (child, (const xmlChar *) "address");
650 if (!address) continue;
654 if (il_interface_devices &&
655 (ignore_device_match (il_interface_devices, name, path) != 0 ||
656 ignore_device_match (il_interface_devices, name, address) != 0))
659 add_interface_device (dom, path, address, j+1);
661 if (path) xmlFree (path);
662 if (address) xmlFree (address);
666 if (xpath_obj) xmlXPathFreeObject (xpath_obj);
667 if (xpath_ctx) xmlXPathFreeContext (xpath_ctx);
668 if (xml_doc) xmlFreeDoc (xml_doc);
684 for (i = 0; i < nr_domains; ++i)
685 virDomainFree (domains[i]);
693 add_domain (virDomainPtr dom)
695 virDomainPtr *new_ptr;
696 int new_size = sizeof (domains[0]) * (nr_domains+1);
699 new_ptr = realloc (domains, new_size);
701 new_ptr = malloc (new_size);
707 domains[nr_domains] = dom;
712 free_block_devices ()
717 for (i = 0; i < nr_block_devices; ++i)
718 sfree (block_devices[i].path);
719 sfree (block_devices);
721 block_devices = NULL;
722 nr_block_devices = 0;
726 add_block_device (virDomainPtr dom, const char *path)
728 struct block_device *new_ptr;
729 int new_size = sizeof (block_devices[0]) * (nr_block_devices+1);
732 path_copy = strdup (path);
737 new_ptr = realloc (block_devices, new_size);
739 new_ptr = malloc (new_size);
741 if (new_ptr == NULL) {
745 block_devices = new_ptr;
746 block_devices[nr_block_devices].dom = dom;
747 block_devices[nr_block_devices].path = path_copy;
748 return nr_block_devices++;
752 free_interface_devices ()
756 if (interface_devices) {
757 for (i = 0; i < nr_interface_devices; ++i) {
758 sfree (interface_devices[i].path);
759 sfree (interface_devices[i].address);
760 sfree (interface_devices[i].number);
762 sfree (interface_devices);
764 interface_devices = NULL;
765 nr_interface_devices = 0;
769 add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number)
771 struct interface_device *new_ptr;
772 int new_size = sizeof (interface_devices[0]) * (nr_interface_devices+1);
773 char *path_copy, *address_copy, number_string[15];
775 path_copy = strdup (path);
776 if (!path_copy) return -1;
778 address_copy = strdup (address);
784 snprintf(number_string, sizeof (number_string), "interface-%u", number);
786 if (interface_devices)
787 new_ptr = realloc (interface_devices, new_size);
789 new_ptr = malloc (new_size);
791 if (new_ptr == NULL) {
793 sfree (address_copy);
796 interface_devices = new_ptr;
797 interface_devices[nr_interface_devices].dom = dom;
798 interface_devices[nr_interface_devices].path = path_copy;
799 interface_devices[nr_interface_devices].address = address_copy;
800 interface_devices[nr_interface_devices].number = strdup(number_string);
801 return nr_interface_devices++;
805 ignore_device_match (ignorelist_t *il, const char *domname, const char *devpath)
810 n = sizeof (char) * (strlen (domname) + strlen (devpath) + 2);
813 ERROR ("libvirt plugin: malloc failed.");
816 ssnprintf (name, n, "%s:%s", domname, devpath);
817 r = ignorelist_match (il, name);
825 free_block_devices ();
826 free_interface_devices ();
830 virConnectClose (conn);
833 ignorelist_free (il_domains);
835 ignorelist_free (il_block_devices);
836 il_block_devices = NULL;
837 ignorelist_free (il_interface_devices);
838 il_interface_devices = NULL;
844 module_register (void)
846 plugin_register_config ("libvirt",
848 config_keys, NR_CONFIG_KEYS);
849 plugin_register_init ("libvirt", lv_init);
850 plugin_register_read ("libvirt", lv_read);
851 plugin_register_shutdown ("libvirt", lv_shutdown);
855 * vim: shiftwidth=4 tabstop=8 softtabstop=4 expandtab fdm=marker