src/virt.c

   1 /**
   2  * collectd - src/virt.c
   3  * Copyright (C) 2006-2008  Red Hat Inc.
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Richard W.M. Jones <rjones@redhat.com>
  20  **/
  21
  22 #include "collectd.h"
  23
  24 #include "common.h"
  25 #include "plugin.h"
  26 #include "utils_complain.h"
  27 #include "utils_ignorelist.h"
  28
  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>
  36
  37 /* Plugin name */
  38 #define PLUGIN_NAME "virt"
  39
  40 static const char *config_keys[] = {"Connection",
  41
  42                                     "RefreshInterval",
  43
  44                                     "Domain",
  45                                     "BlockDevice",
  46                                     "BlockDeviceFormat",
  47                                     "BlockDeviceFormatBasename",
  48                                     "InterfaceDevice",
  49                                     "IgnoreSelected",
  50
  51                                     "HostnameFormat",
  52                                     "InterfaceFormat",
  53
  54                                     "PluginInstanceFormat",
  55
  56                                     "Instances",
  57
  58                                     NULL};
  59 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
  60
  61 /* Connection. */
  62 static virConnectPtr conn = 0;
  63 static char *conn_string = NULL;
  64 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
  65
  66 /* Seconds between list refreshes, 0 disables completely. */
  67 static int interval = 60;
  68
  69 /* List of domains, if specified. */
  70 static ignorelist_t *il_domains = NULL;
  71 /* List of block devices, if specified. */
  72 static ignorelist_t *il_block_devices = NULL;
  73 /* List of network interface devices, if specified. */
  74 static ignorelist_t *il_interface_devices = NULL;
  75
  76 static int ignore_device_match(ignorelist_t *, const char *domname,
  77                                const char *devpath);
  78
  79 /* Actual list of block devices found on last refresh. */
  80 struct block_device {
  81   virDomainPtr dom; /* domain */
  82   char *path;       /* name of block device */
  83 };
  84
  85 /* Actual list of network interfaces found on last refresh. */
  86 struct interface_device {
  87   virDomainPtr dom; /* domain */
  88   char *path;       /* name of interface device */
  89   char *address;    /* mac address of interface device */
  90   char *number;     /* interface device number */
  91 };
  92
  93 struct lv_read_state {
  94   /* Actual list of domains found on last refresh. */
  95   virDomainPtr *domains;
  96   int nr_domains;
  97
  98   struct block_device *block_devices;
  99   int nr_block_devices;
 100
 101   struct interface_device *interface_devices;
 102   int nr_interface_devices;
 103 };
 104
 105 static void free_domains(struct lv_read_state *state);
 106 static int add_domain(struct lv_read_state *state, virDomainPtr dom);
 107
 108 static void free_block_devices(struct lv_read_state *state);
 109 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
 110                             const char *path);
 111
 112 static void free_interface_devices(struct lv_read_state *state);
 113 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
 114                                 const char *path, const char *address,
 115                                 unsigned int number);
 116
 117 #define METADATA_VM_PARTITION_URI "http://ovirt.org/ovirtmap/tag/1.0"
 118 #define METADATA_VM_PARTITION_ELEMENT "tag"
 119 #define METADATA_VM_PARTITION_PREFIX "ovirtmap"
 120
 121 #define BUFFER_MAX_LEN 256
 122 #define PARTITION_TAG_MAX_LEN 32
 123
 124 struct lv_read_instance {
 125   struct lv_read_state read_state;
 126   char tag[PARTITION_TAG_MAX_LEN];
 127   size_t id;
 128 };
 129
 130 struct lv_user_data {
 131   struct lv_read_instance inst;
 132   user_data_t ud;
 133 };
 134
 135 #define NR_INSTANCES_DEFAULT 1
 136 #define NR_INSTANCES_MAX 128
 137 static int nr_instances = NR_INSTANCES_DEFAULT;
 138 static struct lv_user_data lv_read_user_data[NR_INSTANCES_MAX];
 139
 140 /* HostnameFormat. */
 141 #define HF_MAX_FIELDS 3
 142
 143 enum hf_field { hf_none = 0, hf_hostname, hf_name, hf_uuid };
 144
 145 static enum hf_field hostname_format[HF_MAX_FIELDS] = {hf_name};
 146
 147 /* PluginInstanceFormat */
 148 #define PLGINST_MAX_FIELDS 2
 149
 150 enum plginst_field { plginst_none = 0, plginst_name, plginst_uuid };
 151
 152 static enum plginst_field plugin_instance_format[PLGINST_MAX_FIELDS] = {
 153     plginst_none};
 154
 155 /* BlockDeviceFormat */
 156 enum bd_field { target, source };
 157
 158 /* InterfaceFormat. */
 159 enum if_field { if_address, if_name, if_number };
 160
 161 /* BlockDeviceFormatBasename */
 162 _Bool blockdevice_format_basename = 0;
 163 static enum bd_field blockdevice_format = target;
 164 static enum if_field interface_format = if_name;
 165
 166 /* Time that we last refreshed. */
 167 static time_t last_refresh = (time_t)0;
 168
 169 static int refresh_lists(struct lv_read_instance *inst);
 170
 171 /* ERROR(...) macro for virterrors. */
 172 #define VIRT_ERROR(conn, s)                                                    \
 173   do {                                                                         \
 174     virErrorPtr err;                                                           \
 175     err = (conn) ? virConnGetLastError((conn)) : virGetLastError();            \
 176     if (err)                                                                   \
 177       ERROR("%s: %s", (s), err->message);                                      \
 178   } while (0)
 179
 180 static void init_value_list(value_list_t *vl, virDomainPtr dom) {
 181   int n;
 182   const char *name;
 183   char uuid[VIR_UUID_STRING_BUFLEN];
 184
 185   sstrncpy(vl->plugin, PLUGIN_NAME, sizeof(vl->plugin));
 186
 187   vl->host[0] = '\0';
 188
 189   /* Construct the hostname field according to HostnameFormat. */
 190   for (int i = 0; i < HF_MAX_FIELDS; ++i) {
 191     if (hostname_format[i] == hf_none)
 192       continue;
 193
 194     n = DATA_MAX_NAME_LEN - strlen(vl->host) - 2;
 195
 196     if (i > 0 && n >= 1) {
 197       strncat(vl->host, ":", 1);
 198       n--;
 199     }
 200
 201     switch (hostname_format[i]) {
 202     case hf_none:
 203       break;
 204     case hf_hostname:
 205       strncat(vl->host, hostname_g, n);
 206       break;
 207     case hf_name:
 208       name = virDomainGetName(dom);
 209       if (name)
 210         strncat(vl->host, name, n);
 211       break;
 212     case hf_uuid:
 213       if (virDomainGetUUIDString(dom, uuid) == 0)
 214         strncat(vl->host, uuid, n);
 215       break;
 216     }
 217   }
 218
 219   vl->host[sizeof(vl->host) - 1] = '\0';
 220
 221   /* Construct the plugin instance field according to PluginInstanceFormat. */
 222   for (int i = 0; i < PLGINST_MAX_FIELDS; ++i) {
 223     if (plugin_instance_format[i] == plginst_none)
 224       continue;
 225
 226     n = sizeof(vl->plugin_instance) - strlen(vl->plugin_instance) - 2;
 227
 228     if (i > 0 && n >= 1) {
 229       strncat(vl->plugin_instance, ":", 1);
 230       n--;
 231     }
 232
 233     switch (plugin_instance_format[i]) {
 234     case plginst_none:
 235       break;
 236     case plginst_name:
 237       name = virDomainGetName(dom);
 238       if (name)
 239         strncat(vl->plugin_instance, name, n);
 240       break;
 241     case plginst_uuid:
 242       if (virDomainGetUUIDString(dom, uuid) == 0)
 243         strncat(vl->plugin_instance, uuid, n);
 244       break;
 245     }
 246   }
 247
 248   vl->plugin_instance[sizeof(vl->plugin_instance) - 1] = '\0';
 249
 250 } /* void init_value_list */
 251
 252 static void submit(virDomainPtr dom, char const *type,
 253                    char const *type_instance, value_t *values,
 254                    size_t values_len) {
 255   value_list_t vl = VALUE_LIST_INIT;
 256   init_value_list(&vl, dom);
 257
 258   vl.values = values;
 259   vl.values_len = values_len;
 260
 261   sstrncpy(vl.type, type, sizeof(vl.type));
 262   if (type_instance != NULL)
 263     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 264
 265   plugin_dispatch_values(&vl);
 266 }
 267
 268 static void memory_submit(gauge_t value, virDomainPtr dom) {
 269   submit(dom, "memory", "total", &(value_t){.gauge = value}, 1);
 270 }
 271
 272 static void memory_stats_submit(gauge_t value, virDomainPtr dom,
 273                                 int tag_index) {
 274   static const char *tags[] = {"swap_in",        "swap_out", "major_fault",
 275                                "minor_fault",    "unused",   "available",
 276                                "actual_balloon", "rss"};
 277
 278   if ((tag_index < 0) || (tag_index >= STATIC_ARRAY_SIZE(tags))) {
 279     ERROR("virt plugin: Array index out of bounds: tag_index = %d", tag_index);
 280     return;
 281   }
 282
 283   submit(dom, "memory", tags[tag_index], &(value_t){.gauge = value}, 1);
 284 }
 285
 286 static void cpu_submit(unsigned long long value, virDomainPtr dom,
 287                        const char *type) {
 288   submit(dom, type, NULL, &(value_t){.derive = (derive_t)value}, 1);
 289 }
 290
 291 static void vcpu_submit(derive_t value, virDomainPtr dom, int vcpu_nr,
 292                         const char *type) {
 293   char type_instance[DATA_MAX_NAME_LEN];
 294
 295   ssnprintf(type_instance, sizeof(type_instance), "%d", vcpu_nr);
 296
 297   submit(dom, type, type_instance, &(value_t){.derive = value}, 1);
 298 }
 299
 300 static void submit_derive2(const char *type, derive_t v0, derive_t v1,
 301                            virDomainPtr dom, const char *devname) {
 302   value_t values[] = {
 303       {.derive = v0}, {.derive = v1},
 304   };
 305
 306   submit(dom, type, devname, values, STATIC_ARRAY_SIZE(values));
 307 } /* void submit_derive2 */
 308
 309 static int lv_config(const char *key, const char *value) {
 310   if (virInitialize() != 0)
 311     return 1;
 312
 313   if (il_domains == NULL)
 314     il_domains = ignorelist_create(1);
 315   if (il_block_devices == NULL)
 316     il_block_devices = ignorelist_create(1);
 317   if (il_interface_devices == NULL)
 318     il_interface_devices = ignorelist_create(1);
 319
 320   if (strcasecmp(key, "Connection") == 0) {
 321     char *tmp = strdup(value);
 322     if (tmp == NULL) {
 323       ERROR(PLUGIN_NAME " plugin: Connection strdup failed.");
 324       return 1;
 325     }
 326     sfree(conn_string);
 327     conn_string = tmp;
 328     return 0;
 329   }
 330
 331   if (strcasecmp(key, "RefreshInterval") == 0) {
 332     char *eptr = NULL;
 333     interval = strtol(value, &eptr, 10);
 334     if (eptr == NULL || *eptr != '\0')
 335       return 1;
 336     return 0;
 337   }
 338
 339   if (strcasecmp(key, "Domain") == 0) {
 340     if (ignorelist_add(il_domains, value))
 341       return 1;
 342     return 0;
 343   }
 344   if (strcasecmp(key, "BlockDevice") == 0) {
 345     if (ignorelist_add(il_block_devices, value))
 346       return 1;
 347     return 0;
 348   }
 349
 350   if (strcasecmp(key, "BlockDeviceFormat") == 0) {
 351     if (strcasecmp(value, "target") == 0)
 352       blockdevice_format = target;
 353     else if (strcasecmp(value, "source") == 0)
 354       blockdevice_format = source;
 355     else {
 356       ERROR(PLUGIN_NAME " plugin: unknown BlockDeviceFormat: %s", value);
 357       return -1;
 358     }
 359     return 0;
 360   }
 361   if (strcasecmp(key, "BlockDeviceFormatBasename") == 0) {
 362     blockdevice_format_basename = IS_TRUE(value);
 363     return 0;
 364   }
 365   if (strcasecmp(key, "InterfaceDevice") == 0) {
 366     if (ignorelist_add(il_interface_devices, value))
 367       return 1;
 368     return 0;
 369   }
 370
 371   if (strcasecmp(key, "IgnoreSelected") == 0) {
 372     if (IS_TRUE(value)) {
 373       ignorelist_set_invert(il_domains, 0);
 374       ignorelist_set_invert(il_block_devices, 0);
 375       ignorelist_set_invert(il_interface_devices, 0);
 376     } else {
 377       ignorelist_set_invert(il_domains, 1);
 378       ignorelist_set_invert(il_block_devices, 1);
 379       ignorelist_set_invert(il_interface_devices, 1);
 380     }
 381     return 0;
 382   }
 383
 384   if (strcasecmp(key, "HostnameFormat") == 0) {
 385     char *value_copy;
 386     char *fields[HF_MAX_FIELDS];
 387     int n;
 388
 389     value_copy = strdup(value);
 390     if (value_copy == NULL) {
 391       ERROR(PLUGIN_NAME " plugin: strdup failed.");
 392       return -1;
 393     }
 394
 395     n = strsplit(value_copy, fields, HF_MAX_FIELDS);
 396     if (n < 1) {
 397       sfree(value_copy);
 398       ERROR(PLUGIN_NAME " plugin: HostnameFormat: no fields");
 399       return -1;
 400     }
 401
 402     for (int i = 0; i < n; ++i) {
 403       if (strcasecmp(fields[i], "hostname") == 0)
 404         hostname_format[i] = hf_hostname;
 405       else if (strcasecmp(fields[i], "name") == 0)
 406         hostname_format[i] = hf_name;
 407       else if (strcasecmp(fields[i], "uuid") == 0)
 408         hostname_format[i] = hf_uuid;
 409       else {
 410         ERROR(PLUGIN_NAME " plugin: unknown HostnameFormat field: %s",
 411               fields[i]);
 412         sfree(value_copy);
 413         return -1;
 414       }
 415     }
 416     sfree(value_copy);
 417
 418     for (int i = n; i < HF_MAX_FIELDS; ++i)
 419       hostname_format[i] = hf_none;
 420
 421     return 0;
 422   }
 423
 424   if (strcasecmp(key, "PluginInstanceFormat") == 0) {
 425     char *value_copy;
 426     char *fields[PLGINST_MAX_FIELDS];
 427     int n;
 428
 429     value_copy = strdup(value);
 430     if (value_copy == NULL) {
 431       ERROR(PLUGIN_NAME " plugin: strdup failed.");
 432       return -1;
 433     }
 434
 435     n = strsplit(value_copy, fields, PLGINST_MAX_FIELDS);
 436     if (n < 1) {
 437       sfree(value_copy);
 438       ERROR(PLUGIN_NAME " plugin: PluginInstanceFormat: no fields");
 439       return -1;
 440     }
 441
 442     for (int i = 0; i < n; ++i) {
 443       if (strcasecmp(fields[i], "none") == 0) {
 444         plugin_instance_format[i] = plginst_none;
 445         break;
 446       } else if (strcasecmp(fields[i], "name") == 0)
 447         plugin_instance_format[i] = plginst_name;
 448       else if (strcasecmp(fields[i], "uuid") == 0)
 449         plugin_instance_format[i] = plginst_uuid;
 450       else {
 451         ERROR(PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s",
 452               fields[i]);
 453         sfree(value_copy);
 454         return -1;
 455       }
 456     }
 457     sfree(value_copy);
 458
 459     for (int i = n; i < PLGINST_MAX_FIELDS; ++i)
 460       plugin_instance_format[i] = plginst_none;
 461
 462     return 0;
 463   }
 464
 465   if (strcasecmp(key, "InterfaceFormat") == 0) {
 466     if (strcasecmp(value, "name") == 0)
 467       interface_format = if_name;
 468     else if (strcasecmp(value, "address") == 0)
 469       interface_format = if_address;
 470     else if (strcasecmp(value, "number") == 0)
 471       interface_format = if_number;
 472     else {
 473       ERROR(PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", value);
 474       return -1;
 475     }
 476     return 0;
 477   }
 478
 479   if (strcasecmp(key, "Instances") == 0) {
 480     char *eptr = NULL;
 481     double val = strtod(value, &eptr);
 482
 483     if (*eptr != '\0') {
 484       ERROR(PLUGIN_NAME " plugin: Invalid value for Instances = '%s'", value);
 485       return 1;
 486     }
 487     if (val <= 0) {
 488       ERROR(PLUGIN_NAME " plugin: Instances <= 0 makes no sense.");
 489       return 1;
 490     }
 491     if (val > NR_INSTANCES_MAX) {
 492       ERROR(PLUGIN_NAME " plugin: Instances=%f > NR_INSTANCES_MAX=%i"
 493                         " use a lower setting or recompile the plugin.",
 494             val, NR_INSTANCES_MAX);
 495       return 1;
 496     }
 497
 498     nr_instances = (int)val;
 499     DEBUG(PLUGIN_NAME " plugin: configured %i instances", nr_instances);
 500     return 0;
 501   }
 502
 503   /* Unrecognised option. */
 504   return -1;
 505 }
 506
 507 static int lv_connect(void) {
 508   if (conn == NULL) {
 509     /* `conn_string == NULL' is acceptable. */
 510     conn = virConnectOpenReadOnly(conn_string);
 511     if (conn == NULL) {
 512       c_complain(LOG_ERR, &conn_complain,
 513                  PLUGIN_NAME " plugin: Unable to connect: "
 514                              "virConnectOpenReadOnly failed.");
 515       return -1;
 516     }
 517   }
 518   c_release(LOG_NOTICE, &conn_complain,
 519             PLUGIN_NAME " plugin: Connection established.");
 520   return 0;
 521 }
 522
 523 static int lv_read(user_data_t *ud) {
 524   time_t t;
 525   struct lv_read_instance *inst = NULL;
 526   struct lv_read_state *state = NULL;
 527
 528   if (ud->data == NULL) {
 529     ERROR(PLUGIN_NAME " plugin: NULL userdata");
 530     return -1;
 531   }
 532
 533   inst = ud->data;
 534   state = &inst->read_state;
 535
 536   if (inst->id == 0) {
 537     if (lv_connect() < 0)
 538       return -1;
 539   }
 540
 541   time(&t);
 542
 543   /* Need to refresh domain or device lists? */
 544   if ((last_refresh == (time_t)0) ||
 545       ((interval > 0) && ((last_refresh + interval) <= t))) {
 546     if (refresh_lists(inst) != 0) {
 547       if (conn != NULL)
 548         virConnectClose(conn);
 549       conn = NULL;
 550       return -1;
 551     }
 552     last_refresh = t;
 553   }
 554
 555 #if 0
 556     for (int i = 0; i < nr_domains; ++i)
 557         fprintf (stderr, "domain %s\n", virDomainGetName (domains[i]));
 558     for (int i = 0; i < nr_block_devices; ++i)
 559         fprintf  (stderr, "block device %d %s:%s\n",
 560                   i, virDomainGetName (block_devices[i].dom),
 561                   block_devices[i].path);
 562     for (int i = 0; i < nr_interface_devices; ++i)
 563         fprintf (stderr, "interface device %d %s:%s\n",
 564                  i, virDomainGetName (interface_devices[i].dom),
 565                  interface_devices[i].path);
 566 #endif
 567
 568   /* Get CPU usage, memory, VCPU usage for each domain. */
 569   for (int i = 0; i < state->nr_domains; ++i) {
 570     virDomainInfo info;
 571     virVcpuInfoPtr vinfo = NULL;
 572     virDomainMemoryStatPtr minfo = NULL;
 573     int status;
 574
 575     status = virDomainGetInfo(state->domains[i], &info);
 576     if (status != 0) {
 577       ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
 578             status);
 579       continue;
 580     }
 581
 582     if (info.state != VIR_DOMAIN_RUNNING) {
 583       /* only gather stats for running domains */
 584       continue;
 585     }
 586
 587     cpu_submit(info.cpuTime, state->domains[i], "virt_cpu_total");
 588     memory_submit((gauge_t)info.memory * 1024, state->domains[i]);
 589
 590     vinfo = malloc(info.nrVirtCpu * sizeof(vinfo[0]));
 591     if (vinfo == NULL) {
 592       ERROR(PLUGIN_NAME " plugin: malloc failed.");
 593       continue;
 594     }
 595
 596     status = virDomainGetVcpus(state->domains[i], vinfo, info.nrVirtCpu,
 597                                /* cpu map = */ NULL, /* cpu map length = */ 0);
 598     if (status < 0) {
 599       ERROR(PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
 600             status);
 601       sfree(vinfo);
 602       continue;
 603     }
 604
 605     for (int j = 0; j < info.nrVirtCpu; ++j)
 606       vcpu_submit(vinfo[j].cpuTime, state->domains[i], vinfo[j].number,
 607                   "virt_vcpu");
 608
 609     sfree(vinfo);
 610
 611     minfo =
 612         malloc(VIR_DOMAIN_MEMORY_STAT_NR * sizeof(virDomainMemoryStatStruct));
 613     if (minfo == NULL) {
 614       ERROR("virt plugin: malloc failed.");
 615       continue;
 616     }
 617
 618     status = virDomainMemoryStats(state->domains[i], minfo,
 619                                   VIR_DOMAIN_MEMORY_STAT_NR, 0);
 620
 621     if (status < 0) {
 622       ERROR("virt plugin: virDomainMemoryStats failed with status %i.", status);
 623       sfree(minfo);
 624       continue;
 625     }
 626
 627     for (int j = 0; j < status; j++) {
 628       memory_stats_submit((gauge_t)minfo[j].val * 1024, state->domains[i],
 629                           minfo[j].tag);
 630     }
 631
 632     sfree(minfo);
 633   }
 634
 635   /* Get block device stats for each domain. */
 636   for (int i = 0; i < state->nr_block_devices; ++i) {
 637     struct _virDomainBlockStats stats;
 638
 639     if (virDomainBlockStats(state->block_devices[i].dom,
 640                             state->block_devices[i].path, &stats,
 641                             sizeof stats) != 0)
 642       continue;
 643
 644     char *type_instance = NULL;
 645     if (blockdevice_format_basename && blockdevice_format == source)
 646       type_instance = strdup(basename(state->block_devices[i].path));
 647     else
 648       type_instance = strdup(state->block_devices[i].path);
 649
 650     if ((stats.rd_req != -1) && (stats.wr_req != -1))
 651       submit_derive2("disk_ops", (derive_t)stats.rd_req, (derive_t)stats.wr_req,
 652                      state->block_devices[i].dom, type_instance);
 653
 654     if ((stats.rd_bytes != -1) && (stats.wr_bytes != -1))
 655       submit_derive2("disk_octets", (derive_t)stats.rd_bytes,
 656                      (derive_t)stats.wr_bytes, state->block_devices[i].dom,
 657                      type_instance);
 658
 659     sfree(type_instance);
 660   } /* for (nr_block_devices) */
 661
 662   /* Get interface stats for each domain. */
 663   for (int i = 0; i < state->nr_interface_devices; ++i) {
 664     struct _virDomainInterfaceStats stats;
 665     char *display_name = NULL;
 666
 667     switch (interface_format) {
 668     case if_address:
 669       display_name = state->interface_devices[i].address;
 670       break;
 671     case if_number:
 672       display_name = state->interface_devices[i].number;
 673       break;
 674     case if_name:
 675     default:
 676       display_name = state->interface_devices[i].path;
 677     }
 678
 679     if (virDomainInterfaceStats(state->interface_devices[i].dom,
 680                                 state->interface_devices[i].path, &stats,
 681                                 sizeof stats) != 0)
 682       continue;
 683
 684     if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
 685       submit_derive2("if_octets", (derive_t)stats.rx_bytes,
 686                      (derive_t)stats.tx_bytes, state->interface_devices[i].dom,
 687                      display_name);
 688
 689     if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
 690       submit_derive2("if_packets", (derive_t)stats.rx_packets,
 691                      (derive_t)stats.tx_packets,
 692                      state->interface_devices[i].dom, display_name);
 693
 694     if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
 695       submit_derive2("if_errors", (derive_t)stats.rx_errs,
 696                      (derive_t)stats.tx_errs, state->interface_devices[i].dom,
 697                      display_name);
 698
 699     if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
 700       submit_derive2("if_dropped", (derive_t)stats.rx_drop,
 701                      (derive_t)stats.tx_drop, state->interface_devices[i].dom,
 702                      display_name);
 703   } /* for (nr_interface_devices) */
 704
 705   return 0;
 706 }
 707
 708 static int lv_init_instance(size_t i, plugin_read_cb callback) {
 709   struct lv_user_data *lv_ud = &(lv_read_user_data[i]);
 710   struct lv_read_instance *inst = &(lv_ud->inst);
 711
 712   memset(lv_ud, 0, sizeof(*lv_ud));
 713
 714   ssnprintf(inst->tag, sizeof(inst->tag), "%s-%zu", PLUGIN_NAME, i);
 715   inst->id = i;
 716
 717   user_data_t *ud = &(lv_ud->ud);
 718   ud->data = inst;
 719   ud->free_func = NULL;
 720
 721   INFO(PLUGIN_NAME " plugin: reader %s initialized", inst->tag);
 722   return plugin_register_complex_read(NULL, inst->tag, callback, 0, ud);
 723 }
 724
 725 static void lv_clean_read_state(struct lv_read_state *state) {
 726   free_block_devices(state);
 727   free_interface_devices(state);
 728   free_domains(state);
 729 }
 730
 731 static void lv_fini_instance(size_t i) {
 732   struct lv_read_instance *inst = &(lv_read_user_data[i].inst);
 733   struct lv_read_state *state = &(inst->read_state);
 734
 735   lv_clean_read_state(state);
 736   INFO(PLUGIN_NAME " plugin: reader %s finalized", inst->tag);
 737 }
 738
 739 static int lv_init(void) {
 740   if (virInitialize() != 0)
 741     return -1;
 742
 743   lv_connect();
 744
 745   DEBUG(PLUGIN_NAME " plugin: starting %i instances", nr_instances);
 746
 747   for (int i = 0; i < nr_instances; ++i)
 748     lv_init_instance(i, lv_read);
 749
 750   return 0;
 751 }
 752
 753 /*
 754  * returns 0 on success and <0 on error
 755  */
 756 static int lv_domain_get_tag(xmlXPathContextPtr xpath_ctx, const char *dom_name,
 757                              char *dom_tag) {
 758   char xpath_str[BUFFER_MAX_LEN] = {'\0'};
 759   xmlXPathObjectPtr xpath_obj = NULL;
 760   xmlNodePtr xml_node = NULL;
 761   int ret = -1;
 762   int err;
 763
 764   err = xmlXPathRegisterNs(xpath_ctx,
 765                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX,
 766                            (const xmlChar *)METADATA_VM_PARTITION_URI);
 767   if (err) {
 768     ERROR(PLUGIN_NAME " plugin: xmlXpathRegisterNs(%s, %s) failed on domain %s",
 769           METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_URI, dom_name);
 770     goto done;
 771   }
 772
 773   ssnprintf(xpath_str, sizeof(xpath_str), "/domain/metadata/%s:%s/text()",
 774             METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_ELEMENT);
 775   xpath_obj = xmlXPathEvalExpression((xmlChar *)xpath_str, xpath_ctx);
 776   if (xpath_obj == NULL) {
 777     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed on domain %s",
 778           xpath_str, dom_name);
 779     goto done;
 780   }
 781
 782   if (xpath_obj->type != XPATH_NODESET) {
 783     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
 784                       "(wanted %d) on domain %s",
 785           xpath_str, xpath_obj->type, XPATH_NODESET, dom_name);
 786     goto done;
 787   }
 788
 789   /*
 790    * from now on there is no real error, it's ok if a domain
 791    * doesn't have the metadata partition tag.
 792    */
 793   ret = 0;
 794   if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
 795     DEBUG(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
 796                       "expected=1 on domain %s",
 797           xpath_str,
 798           (xpath_obj->nodesetval == NULL) ? 0 : xpath_obj->nodesetval->nodeNr,
 799           dom_name);
 800   } else {
 801     xml_node = xpath_obj->nodesetval->nodeTab[0];
 802     sstrncpy(dom_tag, (const char *)xml_node->content, PARTITION_TAG_MAX_LEN);
 803   }
 804
 805 done:
 806   /* deregister to clean up */
 807   err = xmlXPathRegisterNs(xpath_ctx,
 808                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX, NULL);
 809   if (err) {
 810     /* we can't really recover here */
 811     ERROR(PLUGIN_NAME
 812           " plugin: deregistration of namespace %s failed for domain %s",
 813           METADATA_VM_PARTITION_PREFIX, dom_name);
 814   }
 815   if (xpath_obj)
 816     xmlXPathFreeObject(xpath_obj);
 817
 818   return ret;
 819 }
 820
 821 static int is_known_tag(const char *dom_tag) {
 822   for (int i = 0; i < nr_instances; ++i)
 823     if (!strcmp(dom_tag, lv_read_user_data[i].inst.tag))
 824       return 1;
 825   return 0;
 826 }
 827
 828 static int lv_instance_include_domain(struct lv_read_instance *inst,
 829                                       const char *dom_name,
 830                                       const char *dom_tag) {
 831   if ((dom_tag[0] != '\0') && (strcmp(dom_tag, inst->tag) == 0))
 832     return 1;
 833
 834   /* instance#0 will always be there, so it is in charge of extra duties */
 835   if (inst->id == 0) {
 836     if (dom_tag[0] == '\0' || !is_known_tag(dom_tag)) {
 837       DEBUG(PLUGIN_NAME " plugin#%s: refreshing domain %s "
 838                         "with unknown tag '%s'",
 839             inst->tag, dom_name, dom_tag);
 840       return 1;
 841     }
 842   }
 843
 844   return 0;
 845 }
 846
 847 static int refresh_lists(struct lv_read_instance *inst) {
 848   struct lv_read_state *state = &inst->read_state;
 849   int n;
 850
 851   n = virConnectNumOfDomains(conn);
 852   if (n < 0) {
 853     VIRT_ERROR(conn, "reading number of domains");
 854     return -1;
 855   }
 856
 857   lv_clean_read_state(state);
 858
 859   if (n > 0) {
 860     int *domids;
 861
 862     /* Get list of domains. */
 863     domids = malloc(sizeof(*domids) * n);
 864     if (domids == NULL) {
 865       ERROR(PLUGIN_NAME " plugin: malloc failed.");
 866       return -1;
 867     }
 868
 869     n = virConnectListDomains(conn, domids, n);
 870     if (n < 0) {
 871       VIRT_ERROR(conn, "reading list of domains");
 872       sfree(domids);
 873       return -1;
 874     }
 875
 876     /* Fetch each domain and add it to the list, unless ignore. */
 877     for (int i = 0; i < n; ++i) {
 878       virDomainPtr dom = NULL;
 879       const char *name;
 880       char *xml = NULL;
 881       xmlDocPtr xml_doc = NULL;
 882       xmlXPathContextPtr xpath_ctx = NULL;
 883       xmlXPathObjectPtr xpath_obj = NULL;
 884       char tag[PARTITION_TAG_MAX_LEN] = {'\0'};
 885
 886       dom = virDomainLookupByID(conn, domids[i]);
 887       if (dom == NULL) {
 888         VIRT_ERROR(conn, "virDomainLookupByID");
 889         /* Could be that the domain went away -- ignore it anyway. */
 890         continue;
 891       }
 892
 893       name = virDomainGetName(dom);
 894       if (name == NULL) {
 895         VIRT_ERROR(conn, "virDomainGetName");
 896         goto cont;
 897       }
 898
 899       if (il_domains && ignorelist_match(il_domains, name) != 0)
 900         goto cont;
 901
 902       /* Get a list of devices for this domain. */
 903       xml = virDomainGetXMLDesc(dom, 0);
 904       if (!xml) {
 905         VIRT_ERROR(conn, "virDomainGetXMLDesc");
 906         goto cont;
 907       }
 908
 909       /* Yuck, XML.  Parse out the devices. */
 910       xml_doc = xmlReadDoc((xmlChar *)xml, NULL, NULL, XML_PARSE_NONET);
 911       if (xml_doc == NULL) {
 912         VIRT_ERROR(conn, "xmlReadDoc");
 913         goto cont;
 914       }
 915
 916       xpath_ctx = xmlXPathNewContext(xml_doc);
 917
 918       if (lv_domain_get_tag(xpath_ctx, name, tag) < 0) {
 919         ERROR(PLUGIN_NAME " plugin: lv_domain_get_tag failed.");
 920         goto cont;
 921       }
 922
 923       if (!lv_instance_include_domain(inst, name, tag))
 924         goto cont;
 925
 926       if (add_domain(state, dom) < 0) {
 927         ERROR(PLUGIN_NAME " plugin: malloc failed.");
 928         goto cont;
 929       }
 930
 931       /* Block devices. */
 932       char *bd_xmlpath = "/domain/devices/disk/target[@dev]";
 933       if (blockdevice_format == source)
 934         bd_xmlpath = "/domain/devices/disk/source[@dev]";
 935       xpath_obj = xmlXPathEval((xmlChar *)bd_xmlpath, xpath_ctx);
 936
 937       if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
 938           xpath_obj->nodesetval == NULL)
 939         goto cont;
 940
 941       for (int j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
 942         xmlNodePtr node;
 943         char *path = NULL;
 944
 945         node = xpath_obj->nodesetval->nodeTab[j];
 946         if (!node)
 947           continue;
 948         path = (char *)xmlGetProp(node, (xmlChar *)"dev");
 949         if (!path)
 950           continue;
 951
 952         if (il_block_devices &&
 953             ignore_device_match(il_block_devices, name, path) != 0)
 954           goto cont2;
 955
 956         add_block_device(state, dom, path);
 957       cont2:
 958         if (path)
 959           xmlFree(path);
 960       }
 961       xmlXPathFreeObject(xpath_obj);
 962
 963       /* Network interfaces. */
 964       xpath_obj = xmlXPathEval(
 965           (xmlChar *)"/domain/devices/interface[target[@dev]]", xpath_ctx);
 966       if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
 967           xpath_obj->nodesetval == NULL)
 968         goto cont;
 969
 970       xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
 971
 972       for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
 973         char *path = NULL;
 974         char *address = NULL;
 975         xmlNodePtr xml_interface;
 976
 977         xml_interface = xml_interfaces->nodeTab[j];
 978         if (!xml_interface)
 979           continue;
 980
 981         for (xmlNodePtr child = xml_interface->children; child;
 982              child = child->next) {
 983           if (child->type != XML_ELEMENT_NODE)
 984             continue;
 985
 986           if (xmlStrEqual(child->name, (const xmlChar *)"target")) {
 987             path = (char *)xmlGetProp(child, (const xmlChar *)"dev");
 988             if (!path)
 989               continue;
 990           } else if (xmlStrEqual(child->name, (const xmlChar *)"mac")) {
 991             address = (char *)xmlGetProp(child, (const xmlChar *)"address");
 992             if (!address)
 993               continue;
 994           }
 995         }
 996
 997         if (il_interface_devices &&
 998             (ignore_device_match(il_interface_devices, name, path) != 0 ||
 999              ignore_device_match(il_interface_devices, name, address) != 0))
1000           goto cont3;
1001
1002         add_interface_device(state, dom, path, address, j + 1);
1003       cont3:
1004         if (path)
1005           xmlFree(path);
1006         if (address)
1007           xmlFree(address);
1008       }
1009
1010     cont:
1011       if (xpath_obj)
1012         xmlXPathFreeObject(xpath_obj);
1013       if (xpath_ctx)
1014         xmlXPathFreeContext(xpath_ctx);
1015       if (xml_doc)
1016         xmlFreeDoc(xml_doc);
1017       sfree(xml);
1018     }
1019
1020     sfree(domids);
1021   }
1022
1023   DEBUG(PLUGIN_NAME " plugin#%s: refreshing"
1024                     " domains=%i block_devices=%i iface_devices=%i",
1025         inst->tag, state->nr_domains, state->nr_block_devices,
1026         state->nr_interface_devices);
1027
1028   return 0;
1029 }
1030
1031 static void free_domains(struct lv_read_state *state) {
1032   if (state->domains) {
1033     for (int i = 0; i < state->nr_domains; ++i)
1034       virDomainFree(state->domains[i]);
1035     sfree(state->domains);
1036   }
1037   state->domains = NULL;
1038   state->nr_domains = 0;
1039 }
1040
1041 static int add_domain(struct lv_read_state *state, virDomainPtr dom) {
1042   virDomainPtr *new_ptr;
1043   int new_size = sizeof(state->domains[0]) * (state->nr_domains + 1);
1044
1045   if (state->domains)
1046     new_ptr = realloc(state->domains, new_size);
1047   else
1048     new_ptr = malloc(new_size);
1049
1050   if (new_ptr == NULL)
1051     return -1;
1052
1053   state->domains = new_ptr;
1054   state->domains[state->nr_domains] = dom;
1055   return state->nr_domains++;
1056 }
1057
1058 static void free_block_devices(struct lv_read_state *state) {
1059   if (state->block_devices) {
1060     for (int i = 0; i < state->nr_block_devices; ++i)
1061       sfree(state->block_devices[i].path);
1062     sfree(state->block_devices);
1063   }
1064   state->block_devices = NULL;
1065   state->nr_block_devices = 0;
1066 }
1067
1068 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
1069                             const char *path) {
1070   struct block_device *new_ptr;
1071   int new_size =
1072       sizeof(state->block_devices[0]) * (state->nr_block_devices + 1);
1073   char *path_copy;
1074
1075   path_copy = strdup(path);
1076   if (!path_copy)
1077     return -1;
1078
1079   if (state->block_devices)
1080     new_ptr = realloc(state->block_devices, new_size);
1081   else
1082     new_ptr = malloc(new_size);
1083
1084   if (new_ptr == NULL) {
1085     sfree(path_copy);
1086     return -1;
1087   }
1088   state->block_devices = new_ptr;
1089   state->block_devices[state->nr_block_devices].dom = dom;
1090   state->block_devices[state->nr_block_devices].path = path_copy;
1091   return state->nr_block_devices++;
1092 }
1093
1094 static void free_interface_devices(struct lv_read_state *state) {
1095   if (state->interface_devices) {
1096     for (int i = 0; i < state->nr_interface_devices; ++i) {
1097       sfree(state->interface_devices[i].path);
1098       sfree(state->interface_devices[i].address);
1099       sfree(state->interface_devices[i].number);
1100     }
1101     sfree(state->interface_devices);
1102   }
1103   state->interface_devices = NULL;
1104   state->nr_interface_devices = 0;
1105 }
1106
1107 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
1108                                 const char *path, const char *address,
1109                                 unsigned int number) {
1110   struct interface_device *new_ptr;
1111   int new_size =
1112       sizeof(state->interface_devices[0]) * (state->nr_interface_devices + 1);
1113   char *path_copy, *address_copy, number_string[15];
1114
1115   if ((path == NULL) || (address == NULL))
1116     return EINVAL;
1117
1118   path_copy = strdup(path);
1119   if (!path_copy)
1120     return -1;
1121
1122   address_copy = strdup(address);
1123   if (!address_copy) {
1124     sfree(path_copy);
1125     return -1;
1126   }
1127
1128   snprintf(number_string, sizeof(number_string), "interface-%u", number);
1129
1130   if (state->interface_devices)
1131     new_ptr = realloc(state->interface_devices, new_size);
1132   else
1133     new_ptr = malloc(new_size);
1134
1135   if (new_ptr == NULL) {
1136     sfree(path_copy);
1137     sfree(address_copy);
1138     return -1;
1139   }
1140   state->interface_devices = new_ptr;
1141   state->interface_devices[state->nr_interface_devices].dom = dom;
1142   state->interface_devices[state->nr_interface_devices].path = path_copy;
1143   state->interface_devices[state->nr_interface_devices].address = address_copy;
1144   state->interface_devices[state->nr_interface_devices].number =
1145       strdup(number_string);
1146   return state->nr_interface_devices++;
1147 }
1148
1149 static int ignore_device_match(ignorelist_t *il, const char *domname,
1150                                const char *devpath) {
1151   char *name;
1152   int n, r;
1153
1154   if ((domname == NULL) || (devpath == NULL))
1155     return 0;
1156
1157   n = sizeof(char) * (strlen(domname) + strlen(devpath) + 2);
1158   name = malloc(n);
1159   if (name == NULL) {
1160     ERROR(PLUGIN_NAME " plugin: malloc failed.");
1161     return 0;
1162   }
1163   ssnprintf(name, n, "%s:%s", domname, devpath);
1164   r = ignorelist_match(il, name);
1165   sfree(name);
1166   return r;
1167 }
1168
1169 static int lv_shutdown(void) {
1170   for (int i = 0; i < nr_instances; ++i) {
1171     lv_fini_instance(i);
1172   }
1173
1174   if (conn != NULL)
1175     virConnectClose(conn);
1176   conn = NULL;
1177
1178   ignorelist_free(il_domains);
1179   il_domains = NULL;
1180   ignorelist_free(il_block_devices);
1181   il_block_devices = NULL;
1182   ignorelist_free(il_interface_devices);
1183   il_interface_devices = NULL;
1184
1185   return 0;
1186 }
1187
1188 void module_register(void) {
1189   plugin_register_config(PLUGIN_NAME, lv_config, config_keys, NR_CONFIG_KEYS);
1190   plugin_register_init(PLUGIN_NAME, lv_init);
1191   plugin_register_shutdown(PLUGIN_NAME, lv_shutdown);
1192 }