2 * collectd - src/virt.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>
26 #include "utils_complain.h"
27 #include "utils_ignorelist.h"
29 #include <libgen.h> /* for basename(3) */
30 #include <libvirt/libvirt.h>
31 #include <libvirt/virterror.h>
32 #include <libxml/parser.h>
33 #include <libxml/tree.h>
34 #include <libxml/xpath.h>
35 #include <libxml/xpathInternals.h>
38 #define PLUGIN_NAME "virt"
40 #ifdef LIBVIR_CHECK_VERSION
41 #if LIBVIR_CHECK_VERSION(0, 9, 5)
42 #define HAVE_BLOCK_STATS_FLAGS 1
46 static const char *config_keys[] = {"Connection",
53 "BlockDeviceFormatBasename",
60 "PluginInstanceFormat",
65 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
68 static virConnectPtr conn = 0;
69 static char *conn_string = NULL;
70 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
72 /* Seconds between list refreshes, 0 disables completely. */
73 static int interval = 60;
75 /* List of domains, if specified. */
76 static ignorelist_t *il_domains = NULL;
77 /* List of block devices, if specified. */
78 static ignorelist_t *il_block_devices = NULL;
79 /* List of network interface devices, if specified. */
80 static ignorelist_t *il_interface_devices = NULL;
82 static int ignore_device_match(ignorelist_t *, const char *domname,
85 /* Actual list of block devices found on last refresh. */
87 virDomainPtr dom; /* domain */
88 char *path; /* name of block device */
91 /* Actual list of network interfaces found on last refresh. */
92 struct interface_device {
93 virDomainPtr dom; /* domain */
94 char *path; /* name of interface device */
95 char *address; /* mac address of interface device */
96 char *number; /* interface device number */
99 struct lv_read_state {
100 /* Actual list of domains found on last refresh. */
101 virDomainPtr *domains;
104 struct block_device *block_devices;
105 int nr_block_devices;
107 struct interface_device *interface_devices;
108 int nr_interface_devices;
111 static void free_domains(struct lv_read_state *state);
112 static int add_domain(struct lv_read_state *state, virDomainPtr dom);
114 static void free_block_devices(struct lv_read_state *state);
115 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
118 static void free_interface_devices(struct lv_read_state *state);
119 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
120 const char *path, const char *address,
121 unsigned int number);
123 #define METADATA_VM_PARTITION_URI "http://ovirt.org/ovirtmap/tag/1.0"
124 #define METADATA_VM_PARTITION_ELEMENT "tag"
125 #define METADATA_VM_PARTITION_PREFIX "ovirtmap"
127 #define BUFFER_MAX_LEN 256
128 #define PARTITION_TAG_MAX_LEN 32
130 struct lv_read_instance {
131 struct lv_read_state read_state;
132 char tag[PARTITION_TAG_MAX_LEN];
136 struct lv_user_data {
137 struct lv_read_instance inst;
141 #define NR_INSTANCES_DEFAULT 1
142 #define NR_INSTANCES_MAX 128
143 static int nr_instances = NR_INSTANCES_DEFAULT;
144 static struct lv_user_data lv_read_user_data[NR_INSTANCES_MAX];
146 /* HostnameFormat. */
147 #define HF_MAX_FIELDS 3
149 enum hf_field { hf_none = 0, hf_hostname, hf_name, hf_uuid };
151 static enum hf_field hostname_format[HF_MAX_FIELDS] = {hf_name};
153 /* PluginInstanceFormat */
154 #define PLGINST_MAX_FIELDS 2
156 enum plginst_field { plginst_none = 0, plginst_name, plginst_uuid };
158 static enum plginst_field plugin_instance_format[PLGINST_MAX_FIELDS] = {
161 /* BlockDeviceFormat */
162 enum bd_field { target, source };
164 /* InterfaceFormat. */
165 enum if_field { if_address, if_name, if_number };
167 /* BlockDeviceFormatBasename */
168 _Bool blockdevice_format_basename = 0;
169 static enum bd_field blockdevice_format = target;
170 static enum if_field interface_format = if_name;
172 /* Time that we last refreshed. */
173 static time_t last_refresh = (time_t)0;
175 static int refresh_lists(struct lv_read_instance *inst);
177 struct lv_block_info {
178 virDomainBlockStatsStruct bi;
180 long long rd_total_times;
181 long long wr_total_times;
184 long long fl_total_times;
187 static void init_block_info(struct lv_block_info *binfo) {
191 binfo->bi.rd_req = -1;
192 binfo->bi.wr_req = -1;
193 binfo->bi.rd_bytes = -1;
194 binfo->bi.wr_bytes = -1;
196 binfo->rd_total_times = -1;
197 binfo->wr_total_times = -1;
199 binfo->fl_total_times = -1;
202 #ifdef HAVE_BLOCK_STATS_FLAGS
204 #define GET_BLOCK_INFO_VALUE(NAME, FIELD) \
206 if (!strcmp(param[i].field, NAME)) { \
207 binfo->FIELD = param[i].value.l; \
212 static int get_block_info(struct lv_block_info *binfo,
213 virTypedParameterPtr param, int nparams) {
214 if (binfo == NULL || param == NULL)
217 for (int i = 0; i < nparams; ++i) {
218 /* ignore type. Everything must be LLONG anyway. */
219 GET_BLOCK_INFO_VALUE("rd_operations", bi.rd_req);
220 GET_BLOCK_INFO_VALUE("wr_operations", bi.wr_req);
221 GET_BLOCK_INFO_VALUE("rd_bytes", bi.rd_bytes);
222 GET_BLOCK_INFO_VALUE("wr_bytes", bi.wr_bytes);
223 GET_BLOCK_INFO_VALUE("rd_total_times", rd_total_times);
224 GET_BLOCK_INFO_VALUE("wr_total_times", wr_total_times);
225 GET_BLOCK_INFO_VALUE("flush_operations", fl_req);
226 GET_BLOCK_INFO_VALUE("flush_total_times", fl_total_times);
232 #undef GET_BLOCK_INFO_VALUE
234 #endif /* HAVE_BLOCK_STATS_FLAGS */
236 /* ERROR(...) macro for virterrors. */
237 #define VIRT_ERROR(conn, s) \
240 err = (conn) ? virConnGetLastError((conn)) : virGetLastError(); \
242 ERROR("%s: %s", (s), err->message); \
245 static void init_value_list(value_list_t *vl, virDomainPtr dom) {
248 char uuid[VIR_UUID_STRING_BUFLEN];
250 sstrncpy(vl->plugin, PLUGIN_NAME, sizeof(vl->plugin));
254 /* Construct the hostname field according to HostnameFormat. */
255 for (int i = 0; i < HF_MAX_FIELDS; ++i) {
256 if (hostname_format[i] == hf_none)
259 n = DATA_MAX_NAME_LEN - strlen(vl->host) - 2;
261 if (i > 0 && n >= 1) {
262 strncat(vl->host, ":", 1);
266 switch (hostname_format[i]) {
270 strncat(vl->host, hostname_g, n);
273 name = virDomainGetName(dom);
275 strncat(vl->host, name, n);
278 if (virDomainGetUUIDString(dom, uuid) == 0)
279 strncat(vl->host, uuid, n);
284 vl->host[sizeof(vl->host) - 1] = '\0';
286 /* Construct the plugin instance field according to PluginInstanceFormat. */
287 for (int i = 0; i < PLGINST_MAX_FIELDS; ++i) {
288 if (plugin_instance_format[i] == plginst_none)
291 n = sizeof(vl->plugin_instance) - strlen(vl->plugin_instance) - 2;
293 if (i > 0 && n >= 1) {
294 strncat(vl->plugin_instance, ":", 1);
298 switch (plugin_instance_format[i]) {
302 name = virDomainGetName(dom);
304 strncat(vl->plugin_instance, name, n);
307 if (virDomainGetUUIDString(dom, uuid) == 0)
308 strncat(vl->plugin_instance, uuid, n);
313 vl->plugin_instance[sizeof(vl->plugin_instance) - 1] = '\0';
315 } /* void init_value_list */
317 static void submit(virDomainPtr dom, char const *type,
318 char const *type_instance, value_t *values,
320 value_list_t vl = VALUE_LIST_INIT;
321 init_value_list(&vl, dom);
324 vl.values_len = values_len;
326 sstrncpy(vl.type, type, sizeof(vl.type));
327 if (type_instance != NULL)
328 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
330 plugin_dispatch_values(&vl);
333 static void memory_submit(gauge_t value, virDomainPtr dom) {
334 submit(dom, "memory", "total", &(value_t){.gauge = value}, 1);
337 static void memory_stats_submit(gauge_t value, virDomainPtr dom,
339 static const char *tags[] = {"swap_in", "swap_out", "major_fault",
340 "minor_fault", "unused", "available",
341 "actual_balloon", "rss"};
343 if ((tag_index < 0) || (tag_index >= STATIC_ARRAY_SIZE(tags))) {
344 ERROR("virt plugin: Array index out of bounds: tag_index = %d", tag_index);
348 submit(dom, "memory", tags[tag_index], &(value_t){.gauge = value}, 1);
351 static void cpu_submit(unsigned long long value, virDomainPtr dom,
353 submit(dom, type, NULL, &(value_t){.derive = (derive_t)value}, 1);
356 static void vcpu_submit(derive_t value, virDomainPtr dom, int vcpu_nr,
358 char type_instance[DATA_MAX_NAME_LEN];
360 ssnprintf(type_instance, sizeof(type_instance), "%d", vcpu_nr);
362 submit(dom, type, type_instance, &(value_t){.derive = value}, 1);
365 static void submit_derive2(const char *type, derive_t v0, derive_t v1,
366 virDomainPtr dom, const char *devname) {
368 {.derive = v0}, {.derive = v1},
371 submit(dom, type, devname, values, STATIC_ARRAY_SIZE(values));
372 } /* void submit_derive2 */
374 static void disk_submit(struct lv_block_info *binfo, virDomainPtr dom,
375 const char *type_instance) {
376 if ((binfo->bi.rd_req != -1) && (binfo->bi.wr_req != -1))
377 submit_derive2("disk_ops", (derive_t)binfo->bi.rd_req,
378 (derive_t)binfo->bi.wr_req, dom, type_instance);
380 if ((binfo->bi.rd_bytes != -1) && (binfo->bi.wr_bytes != -1))
381 submit_derive2("disk_octets", (derive_t)binfo->bi.rd_bytes,
382 (derive_t)binfo->bi.wr_bytes, dom, type_instance);
384 if ((binfo->rd_total_times != -1) && (binfo->wr_total_times != -1))
385 submit_derive2("disk_time", (derive_t)binfo->rd_total_times,
386 (derive_t)binfo->wr_total_times, dom, type_instance);
389 static int lv_config(const char *key, const char *value) {
390 if (virInitialize() != 0)
393 if (il_domains == NULL)
394 il_domains = ignorelist_create(1);
395 if (il_block_devices == NULL)
396 il_block_devices = ignorelist_create(1);
397 if (il_interface_devices == NULL)
398 il_interface_devices = ignorelist_create(1);
400 if (strcasecmp(key, "Connection") == 0) {
401 char *tmp = strdup(value);
403 ERROR(PLUGIN_NAME " plugin: Connection strdup failed.");
411 if (strcasecmp(key, "RefreshInterval") == 0) {
413 interval = strtol(value, &eptr, 10);
414 if (eptr == NULL || *eptr != '\0')
419 if (strcasecmp(key, "Domain") == 0) {
420 if (ignorelist_add(il_domains, value))
424 if (strcasecmp(key, "BlockDevice") == 0) {
425 if (ignorelist_add(il_block_devices, value))
430 if (strcasecmp(key, "BlockDeviceFormat") == 0) {
431 if (strcasecmp(value, "target") == 0)
432 blockdevice_format = target;
433 else if (strcasecmp(value, "source") == 0)
434 blockdevice_format = source;
436 ERROR(PLUGIN_NAME " plugin: unknown BlockDeviceFormat: %s", value);
441 if (strcasecmp(key, "BlockDeviceFormatBasename") == 0) {
442 blockdevice_format_basename = IS_TRUE(value);
445 if (strcasecmp(key, "InterfaceDevice") == 0) {
446 if (ignorelist_add(il_interface_devices, value))
451 if (strcasecmp(key, "IgnoreSelected") == 0) {
452 if (IS_TRUE(value)) {
453 ignorelist_set_invert(il_domains, 0);
454 ignorelist_set_invert(il_block_devices, 0);
455 ignorelist_set_invert(il_interface_devices, 0);
457 ignorelist_set_invert(il_domains, 1);
458 ignorelist_set_invert(il_block_devices, 1);
459 ignorelist_set_invert(il_interface_devices, 1);
464 if (strcasecmp(key, "HostnameFormat") == 0) {
466 char *fields[HF_MAX_FIELDS];
469 value_copy = strdup(value);
470 if (value_copy == NULL) {
471 ERROR(PLUGIN_NAME " plugin: strdup failed.");
475 n = strsplit(value_copy, fields, HF_MAX_FIELDS);
478 ERROR(PLUGIN_NAME " plugin: HostnameFormat: no fields");
482 for (int i = 0; i < n; ++i) {
483 if (strcasecmp(fields[i], "hostname") == 0)
484 hostname_format[i] = hf_hostname;
485 else if (strcasecmp(fields[i], "name") == 0)
486 hostname_format[i] = hf_name;
487 else if (strcasecmp(fields[i], "uuid") == 0)
488 hostname_format[i] = hf_uuid;
490 ERROR(PLUGIN_NAME " plugin: unknown HostnameFormat field: %s",
498 for (int i = n; i < HF_MAX_FIELDS; ++i)
499 hostname_format[i] = hf_none;
504 if (strcasecmp(key, "PluginInstanceFormat") == 0) {
506 char *fields[PLGINST_MAX_FIELDS];
509 value_copy = strdup(value);
510 if (value_copy == NULL) {
511 ERROR(PLUGIN_NAME " plugin: strdup failed.");
515 n = strsplit(value_copy, fields, PLGINST_MAX_FIELDS);
518 ERROR(PLUGIN_NAME " plugin: PluginInstanceFormat: no fields");
522 for (int i = 0; i < n; ++i) {
523 if (strcasecmp(fields[i], "none") == 0) {
524 plugin_instance_format[i] = plginst_none;
526 } else if (strcasecmp(fields[i], "name") == 0)
527 plugin_instance_format[i] = plginst_name;
528 else if (strcasecmp(fields[i], "uuid") == 0)
529 plugin_instance_format[i] = plginst_uuid;
531 ERROR(PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s",
539 for (int i = n; i < PLGINST_MAX_FIELDS; ++i)
540 plugin_instance_format[i] = plginst_none;
545 if (strcasecmp(key, "InterfaceFormat") == 0) {
546 if (strcasecmp(value, "name") == 0)
547 interface_format = if_name;
548 else if (strcasecmp(value, "address") == 0)
549 interface_format = if_address;
550 else if (strcasecmp(value, "number") == 0)
551 interface_format = if_number;
553 ERROR(PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", value);
559 if (strcasecmp(key, "Instances") == 0) {
561 double val = strtod(value, &eptr);
564 ERROR(PLUGIN_NAME " plugin: Invalid value for Instances = '%s'", value);
568 ERROR(PLUGIN_NAME " plugin: Instances <= 0 makes no sense.");
571 if (val > NR_INSTANCES_MAX) {
572 ERROR(PLUGIN_NAME " plugin: Instances=%f > NR_INSTANCES_MAX=%i"
573 " use a lower setting or recompile the plugin.",
574 val, NR_INSTANCES_MAX);
578 nr_instances = (int)val;
579 DEBUG(PLUGIN_NAME " plugin: configured %i instances", nr_instances);
583 /* Unrecognised option. */
587 static int lv_connect(void) {
589 /* `conn_string == NULL' is acceptable. */
590 conn = virConnectOpenReadOnly(conn_string);
592 c_complain(LOG_ERR, &conn_complain,
593 PLUGIN_NAME " plugin: Unable to connect: "
594 "virConnectOpenReadOnly failed.");
598 c_release(LOG_NOTICE, &conn_complain,
599 PLUGIN_NAME " plugin: Connection established.");
603 static void lv_disconnect(void) {
605 virConnectClose(conn);
607 WARNING(PLUGIN_NAME " plugin: closed connection to libvirt");
610 static int lv_domain_block_info(virDomainPtr dom, const char *path,
611 struct lv_block_info *binfo) {
612 #ifdef HAVE_BLOCK_STATS_FLAGS
613 virTypedParameterPtr params = NULL;
618 ret = virDomainBlockStatsFlags(dom, path, NULL, &nparams, 0);
619 if (ret < 0 || nparams == 0) {
620 VIRT_ERROR(conn, "getting the disk params count");
624 params = calloc(nparams, sizeof(virTypedParameter));
625 if (params == NULL) {
626 ERROR("virt plugin: alloc(%i) for block=%s parameters failed.", nparams,
630 ret = virDomainBlockStatsFlags(dom, path, params, &nparams, 0);
632 VIRT_ERROR(conn, "getting the disk params values");
636 rc = get_block_info(binfo, params, nparams);
639 virTypedParamsFree(params, nparams);
642 return virDomainBlockStats(dom, path, &(binfo->bi), sizeof(binfo->bi));
643 #endif /* HAVE_BLOCK_STATS_FLAGS */
646 static int lv_read(user_data_t *ud) {
648 struct lv_read_instance *inst = NULL;
649 struct lv_read_state *state = NULL;
651 if (ud->data == NULL) {
652 ERROR(PLUGIN_NAME " plugin: NULL userdata");
657 state = &inst->read_state;
660 if (lv_connect() < 0)
666 /* Need to refresh domain or device lists? */
667 if ((last_refresh == (time_t)0) ||
668 ((interval > 0) && ((last_refresh + interval) <= t))) {
669 if (refresh_lists(inst) != 0) {
678 for (int i = 0; i < nr_domains; ++i)
679 fprintf (stderr, "domain %s\n", virDomainGetName (domains[i]));
680 for (int i = 0; i < nr_block_devices; ++i)
681 fprintf (stderr, "block device %d %s:%s\n",
682 i, virDomainGetName (block_devices[i].dom),
683 block_devices[i].path);
684 for (int i = 0; i < nr_interface_devices; ++i)
685 fprintf (stderr, "interface device %d %s:%s\n",
686 i, virDomainGetName (interface_devices[i].dom),
687 interface_devices[i].path);
690 /* Get CPU usage, memory, VCPU usage for each domain. */
691 for (int i = 0; i < state->nr_domains; ++i) {
693 virVcpuInfoPtr vinfo = NULL;
694 virDomainMemoryStatPtr minfo = NULL;
697 status = virDomainGetInfo(state->domains[i], &info);
699 ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
704 if (info.state != VIR_DOMAIN_RUNNING) {
705 /* only gather stats for running domains */
709 cpu_submit(info.cpuTime, state->domains[i], "virt_cpu_total");
710 memory_submit((gauge_t)info.memory * 1024, state->domains[i]);
712 vinfo = malloc(info.nrVirtCpu * sizeof(vinfo[0]));
714 ERROR(PLUGIN_NAME " plugin: malloc failed.");
718 status = virDomainGetVcpus(state->domains[i], vinfo, info.nrVirtCpu,
719 /* cpu map = */ NULL, /* cpu map length = */ 0);
721 ERROR(PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
727 for (int j = 0; j < info.nrVirtCpu; ++j)
728 vcpu_submit(vinfo[j].cpuTime, state->domains[i], vinfo[j].number,
734 malloc(VIR_DOMAIN_MEMORY_STAT_NR * sizeof(virDomainMemoryStatStruct));
736 ERROR("virt plugin: malloc failed.");
740 status = virDomainMemoryStats(state->domains[i], minfo,
741 VIR_DOMAIN_MEMORY_STAT_NR, 0);
744 ERROR("virt plugin: virDomainMemoryStats failed with status %i.", status);
749 for (int j = 0; j < status; j++) {
750 memory_stats_submit((gauge_t)minfo[j].val * 1024, state->domains[i],
757 /* Get block device stats for each domain. */
758 for (int i = 0; i < state->nr_block_devices; ++i) {
759 struct block_device *bdev = &(state->block_devices[i]);
760 struct lv_block_info binfo;
761 init_block_info(&binfo);
763 if (lv_domain_block_info(bdev->dom, bdev->path, &binfo) < 0)
766 char *type_instance = NULL;
767 if (blockdevice_format_basename && blockdevice_format == source)
768 type_instance = strdup(basename(bdev->path));
770 type_instance = strdup(bdev->path);
772 disk_submit(&binfo, bdev->dom, type_instance);
774 sfree(type_instance);
775 } /* for (nr_block_devices) */
777 /* Get interface stats for each domain. */
778 for (int i = 0; i < state->nr_interface_devices; ++i) {
779 struct _virDomainInterfaceStats stats;
780 char *display_name = NULL;
782 switch (interface_format) {
784 display_name = state->interface_devices[i].address;
787 display_name = state->interface_devices[i].number;
791 display_name = state->interface_devices[i].path;
794 if (virDomainInterfaceStats(state->interface_devices[i].dom,
795 state->interface_devices[i].path, &stats,
799 if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
800 submit_derive2("if_octets", (derive_t)stats.rx_bytes,
801 (derive_t)stats.tx_bytes, state->interface_devices[i].dom,
804 if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
805 submit_derive2("if_packets", (derive_t)stats.rx_packets,
806 (derive_t)stats.tx_packets,
807 state->interface_devices[i].dom, display_name);
809 if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
810 submit_derive2("if_errors", (derive_t)stats.rx_errs,
811 (derive_t)stats.tx_errs, state->interface_devices[i].dom,
814 if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
815 submit_derive2("if_dropped", (derive_t)stats.rx_drop,
816 (derive_t)stats.tx_drop, state->interface_devices[i].dom,
818 } /* for (nr_interface_devices) */
823 static int lv_init_instance(size_t i, plugin_read_cb callback) {
824 struct lv_user_data *lv_ud = &(lv_read_user_data[i]);
825 struct lv_read_instance *inst = &(lv_ud->inst);
827 memset(lv_ud, 0, sizeof(*lv_ud));
829 ssnprintf(inst->tag, sizeof(inst->tag), "%s-%zu", PLUGIN_NAME, i);
832 user_data_t *ud = &(lv_ud->ud);
834 ud->free_func = NULL;
836 INFO(PLUGIN_NAME " plugin: reader %s initialized", inst->tag);
837 return plugin_register_complex_read(NULL, inst->tag, callback, 0, ud);
840 static void lv_clean_read_state(struct lv_read_state *state) {
841 free_block_devices(state);
842 free_interface_devices(state);
846 static void lv_fini_instance(size_t i) {
847 struct lv_read_instance *inst = &(lv_read_user_data[i].inst);
848 struct lv_read_state *state = &(inst->read_state);
850 lv_clean_read_state(state);
851 INFO(PLUGIN_NAME " plugin: reader %s finalized", inst->tag);
854 static int lv_init(void) {
855 if (virInitialize() != 0)
858 if (lv_connect() != 0)
861 DEBUG(PLUGIN_NAME " plugin: starting %i instances", nr_instances);
863 for (int i = 0; i < nr_instances; ++i)
864 lv_init_instance(i, lv_read);
870 * returns 0 on success and <0 on error
872 static int lv_domain_get_tag(xmlXPathContextPtr xpath_ctx, const char *dom_name,
874 char xpath_str[BUFFER_MAX_LEN] = {'\0'};
875 xmlXPathObjectPtr xpath_obj = NULL;
876 xmlNodePtr xml_node = NULL;
880 err = xmlXPathRegisterNs(xpath_ctx,
881 (const xmlChar *)METADATA_VM_PARTITION_PREFIX,
882 (const xmlChar *)METADATA_VM_PARTITION_URI);
884 ERROR(PLUGIN_NAME " plugin: xmlXpathRegisterNs(%s, %s) failed on domain %s",
885 METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_URI, dom_name);
889 ssnprintf(xpath_str, sizeof(xpath_str), "/domain/metadata/%s:%s/text()",
890 METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_ELEMENT);
891 xpath_obj = xmlXPathEvalExpression((xmlChar *)xpath_str, xpath_ctx);
892 if (xpath_obj == NULL) {
893 ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed on domain %s",
894 xpath_str, dom_name);
898 if (xpath_obj->type != XPATH_NODESET) {
899 ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
900 "(wanted %d) on domain %s",
901 xpath_str, xpath_obj->type, XPATH_NODESET, dom_name);
906 * from now on there is no real error, it's ok if a domain
907 * doesn't have the metadata partition tag.
910 if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
911 DEBUG(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
912 "expected=1 on domain %s",
914 (xpath_obj->nodesetval == NULL) ? 0 : xpath_obj->nodesetval->nodeNr,
917 xml_node = xpath_obj->nodesetval->nodeTab[0];
918 sstrncpy(dom_tag, (const char *)xml_node->content, PARTITION_TAG_MAX_LEN);
922 /* deregister to clean up */
923 err = xmlXPathRegisterNs(xpath_ctx,
924 (const xmlChar *)METADATA_VM_PARTITION_PREFIX, NULL);
926 /* we can't really recover here */
928 " plugin: deregistration of namespace %s failed for domain %s",
929 METADATA_VM_PARTITION_PREFIX, dom_name);
932 xmlXPathFreeObject(xpath_obj);
937 static int is_known_tag(const char *dom_tag) {
938 for (int i = 0; i < nr_instances; ++i)
939 if (!strcmp(dom_tag, lv_read_user_data[i].inst.tag))
944 static int lv_instance_include_domain(struct lv_read_instance *inst,
945 const char *dom_name,
946 const char *dom_tag) {
947 if ((dom_tag[0] != '\0') && (strcmp(dom_tag, inst->tag) == 0))
950 /* instance#0 will always be there, so it is in charge of extra duties */
952 if (dom_tag[0] == '\0' || !is_known_tag(dom_tag)) {
953 DEBUG(PLUGIN_NAME " plugin#%s: refreshing domain %s "
954 "with unknown tag '%s'",
955 inst->tag, dom_name, dom_tag);
963 static int refresh_lists(struct lv_read_instance *inst) {
964 struct lv_read_state *state = &inst->read_state;
967 n = virConnectNumOfDomains(conn);
969 VIRT_ERROR(conn, "reading number of domains");
973 lv_clean_read_state(state);
978 /* Get list of domains. */
979 domids = malloc(sizeof(*domids) * n);
980 if (domids == NULL) {
981 ERROR(PLUGIN_NAME " plugin: malloc failed.");
985 n = virConnectListDomains(conn, domids, n);
987 VIRT_ERROR(conn, "reading list of domains");
992 /* Fetch each domain and add it to the list, unless ignore. */
993 for (int i = 0; i < n; ++i) {
994 virDomainPtr dom = NULL;
997 xmlDocPtr xml_doc = NULL;
998 xmlXPathContextPtr xpath_ctx = NULL;
999 xmlXPathObjectPtr xpath_obj = NULL;
1000 char tag[PARTITION_TAG_MAX_LEN] = {'\0'};
1002 dom = virDomainLookupByID(conn, domids[i]);
1004 VIRT_ERROR(conn, "virDomainLookupByID");
1005 /* Could be that the domain went away -- ignore it anyway. */
1009 name = virDomainGetName(dom);
1011 VIRT_ERROR(conn, "virDomainGetName");
1015 if (il_domains && ignorelist_match(il_domains, name) != 0)
1018 /* Get a list of devices for this domain. */
1019 xml = virDomainGetXMLDesc(dom, 0);
1021 VIRT_ERROR(conn, "virDomainGetXMLDesc");
1025 /* Yuck, XML. Parse out the devices. */
1026 xml_doc = xmlReadDoc((xmlChar *)xml, NULL, NULL, XML_PARSE_NONET);
1027 if (xml_doc == NULL) {
1028 VIRT_ERROR(conn, "xmlReadDoc");
1032 xpath_ctx = xmlXPathNewContext(xml_doc);
1034 if (lv_domain_get_tag(xpath_ctx, name, tag) < 0) {
1035 ERROR(PLUGIN_NAME " plugin: lv_domain_get_tag failed.");
1039 if (!lv_instance_include_domain(inst, name, tag))
1042 if (add_domain(state, dom) < 0) {
1043 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1047 /* Block devices. */
1048 const char *bd_xmlpath = "/domain/devices/disk/target[@dev]";
1049 if (blockdevice_format == source)
1050 bd_xmlpath = "/domain/devices/disk/source[@dev]";
1051 xpath_obj = xmlXPathEval((const xmlChar *)bd_xmlpath, xpath_ctx);
1053 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
1054 xpath_obj->nodesetval == NULL)
1057 for (int j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
1061 node = xpath_obj->nodesetval->nodeTab[j];
1064 path = (char *)xmlGetProp(node, (xmlChar *)"dev");
1068 if (il_block_devices &&
1069 ignore_device_match(il_block_devices, name, path) != 0)
1072 add_block_device(state, dom, path);
1077 xmlXPathFreeObject(xpath_obj);
1079 /* Network interfaces. */
1080 xpath_obj = xmlXPathEval(
1081 (xmlChar *)"/domain/devices/interface[target[@dev]]", xpath_ctx);
1082 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
1083 xpath_obj->nodesetval == NULL)
1086 xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
1088 for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
1090 char *address = NULL;
1091 xmlNodePtr xml_interface;
1093 xml_interface = xml_interfaces->nodeTab[j];
1097 for (xmlNodePtr child = xml_interface->children; child;
1098 child = child->next) {
1099 if (child->type != XML_ELEMENT_NODE)
1102 if (xmlStrEqual(child->name, (const xmlChar *)"target")) {
1103 path = (char *)xmlGetProp(child, (const xmlChar *)"dev");
1106 } else if (xmlStrEqual(child->name, (const xmlChar *)"mac")) {
1107 address = (char *)xmlGetProp(child, (const xmlChar *)"address");
1113 if (il_interface_devices &&
1114 (ignore_device_match(il_interface_devices, name, path) != 0 ||
1115 ignore_device_match(il_interface_devices, name, address) != 0))
1118 add_interface_device(state, dom, path, address, j + 1);
1128 xmlXPathFreeObject(xpath_obj);
1130 xmlXPathFreeContext(xpath_ctx);
1132 xmlFreeDoc(xml_doc);
1139 DEBUG(PLUGIN_NAME " plugin#%s: refreshing"
1140 " domains=%i block_devices=%i iface_devices=%i",
1141 inst->tag, state->nr_domains, state->nr_block_devices,
1142 state->nr_interface_devices);
1147 static void free_domains(struct lv_read_state *state) {
1148 if (state->domains) {
1149 for (int i = 0; i < state->nr_domains; ++i)
1150 virDomainFree(state->domains[i]);
1151 sfree(state->domains);
1153 state->domains = NULL;
1154 state->nr_domains = 0;
1157 static int add_domain(struct lv_read_state *state, virDomainPtr dom) {
1158 virDomainPtr *new_ptr;
1159 int new_size = sizeof(state->domains[0]) * (state->nr_domains + 1);
1162 new_ptr = realloc(state->domains, new_size);
1164 new_ptr = malloc(new_size);
1166 if (new_ptr == NULL)
1169 state->domains = new_ptr;
1170 state->domains[state->nr_domains] = dom;
1171 return state->nr_domains++;
1174 static void free_block_devices(struct lv_read_state *state) {
1175 if (state->block_devices) {
1176 for (int i = 0; i < state->nr_block_devices; ++i)
1177 sfree(state->block_devices[i].path);
1178 sfree(state->block_devices);
1180 state->block_devices = NULL;
1181 state->nr_block_devices = 0;
1184 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
1186 struct block_device *new_ptr;
1188 sizeof(state->block_devices[0]) * (state->nr_block_devices + 1);
1191 path_copy = strdup(path);
1195 if (state->block_devices)
1196 new_ptr = realloc(state->block_devices, new_size);
1198 new_ptr = malloc(new_size);
1200 if (new_ptr == NULL) {
1204 state->block_devices = new_ptr;
1205 state->block_devices[state->nr_block_devices].dom = dom;
1206 state->block_devices[state->nr_block_devices].path = path_copy;
1207 return state->nr_block_devices++;
1210 static void free_interface_devices(struct lv_read_state *state) {
1211 if (state->interface_devices) {
1212 for (int i = 0; i < state->nr_interface_devices; ++i) {
1213 sfree(state->interface_devices[i].path);
1214 sfree(state->interface_devices[i].address);
1215 sfree(state->interface_devices[i].number);
1217 sfree(state->interface_devices);
1219 state->interface_devices = NULL;
1220 state->nr_interface_devices = 0;
1223 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
1224 const char *path, const char *address,
1225 unsigned int number) {
1226 struct interface_device *new_ptr;
1228 sizeof(state->interface_devices[0]) * (state->nr_interface_devices + 1);
1229 char *path_copy, *address_copy, number_string[15];
1231 if ((path == NULL) || (address == NULL))
1234 path_copy = strdup(path);
1238 address_copy = strdup(address);
1239 if (!address_copy) {
1244 snprintf(number_string, sizeof(number_string), "interface-%u", number);
1246 if (state->interface_devices)
1247 new_ptr = realloc(state->interface_devices, new_size);
1249 new_ptr = malloc(new_size);
1251 if (new_ptr == NULL) {
1253 sfree(address_copy);
1256 state->interface_devices = new_ptr;
1257 state->interface_devices[state->nr_interface_devices].dom = dom;
1258 state->interface_devices[state->nr_interface_devices].path = path_copy;
1259 state->interface_devices[state->nr_interface_devices].address = address_copy;
1260 state->interface_devices[state->nr_interface_devices].number =
1261 strdup(number_string);
1262 return state->nr_interface_devices++;
1265 static int ignore_device_match(ignorelist_t *il, const char *domname,
1266 const char *devpath) {
1270 if ((domname == NULL) || (devpath == NULL))
1273 n = sizeof(char) * (strlen(domname) + strlen(devpath) + 2);
1276 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1279 ssnprintf(name, n, "%s:%s", domname, devpath);
1280 r = ignorelist_match(il, name);
1285 static int lv_shutdown(void) {
1286 for (int i = 0; i < nr_instances; ++i) {
1287 lv_fini_instance(i);
1292 ignorelist_free(il_domains);
1294 ignorelist_free(il_block_devices);
1295 il_block_devices = NULL;
1296 ignorelist_free(il_interface_devices);
1297 il_interface_devices = NULL;
1302 void module_register(void) {
1303 plugin_register_config(PLUGIN_NAME, lv_config, config_keys, NR_CONFIG_KEYS);
1304 plugin_register_init(PLUGIN_NAME, lv_init);
1305 plugin_register_shutdown(PLUGIN_NAME, lv_shutdown);