virt plugin: Skip 'last_update' reporting as that is not memory but timestamp
[collectd.git] / 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  *   Przemyslaw Szczerbik <przemyslawx.szczerbik@intel.com>
21  **/
22
23 #include "collectd.h"
24
25 #include "plugin.h"
26 #include "utils/common/common.h"
27 #include "utils/ignorelist/ignorelist.h"
28 #include "utils_complain.h"
29
30 #include <libgen.h> /* for basename(3) */
31 #include <libvirt/libvirt.h>
32 #include <libvirt/virterror.h>
33 #include <libxml/parser.h>
34 #include <libxml/tree.h>
35 #include <libxml/xpath.h>
36 #include <libxml/xpathInternals.h>
37 #include <stdbool.h>
38
39 /* Plugin name */
40 #define PLUGIN_NAME "virt"
41
42 /* Secure strcat macro assuring null termination. Parameter (n) is the size of
43    buffer (d), allowing this macro to be safe for static and dynamic buffers */
44 #define SSTRNCAT(d, s, n)                                                      \
45   do {                                                                         \
46     size_t _l = strlen(d);                                                     \
47     sstrncpy((d) + _l, (s), (n)-_l);                                           \
48   } while (0)
49
50 #ifdef LIBVIR_CHECK_VERSION
51
52 #if LIBVIR_CHECK_VERSION(0, 9, 2)
53 #define HAVE_DOM_REASON 1
54 #endif
55
56 #if LIBVIR_CHECK_VERSION(0, 9, 5)
57 #define HAVE_BLOCK_STATS_FLAGS 1
58 #define HAVE_DOM_REASON_PAUSED_SHUTTING_DOWN 1
59 #endif
60
61 #if LIBVIR_CHECK_VERSION(0, 9, 10)
62 #define HAVE_DISK_ERR 1
63 #endif
64
65 #if LIBVIR_CHECK_VERSION(0, 9, 11)
66 #define HAVE_CPU_STATS 1
67 #define HAVE_DOM_STATE_PMSUSPENDED 1
68 #define HAVE_DOM_REASON_RUNNING_WAKEUP 1
69 #endif
70
71 /*
72   virConnectListAllDomains() appeared in 0.10.2
73   Note that LIBVIR_CHECK_VERSION appeared a year later, so
74   in some systems which actually have virConnectListAllDomains()
75   we can't detect this.
76  */
77 #if LIBVIR_CHECK_VERSION(0, 10, 2)
78 #define HAVE_LIST_ALL_DOMAINS 1
79 #endif
80
81 #if LIBVIR_CHECK_VERSION(1, 0, 1)
82 #define HAVE_DOM_REASON_PAUSED_SNAPSHOT 1
83 #endif
84
85 #if LIBVIR_CHECK_VERSION(1, 1, 1)
86 #define HAVE_DOM_REASON_PAUSED_CRASHED 1
87 #endif
88
89 #if LIBVIR_CHECK_VERSION(1, 2, 9)
90 #define HAVE_JOB_STATS 1
91 #endif
92
93 #if LIBVIR_CHECK_VERSION(1, 2, 10)
94 #define HAVE_DOM_REASON_CRASHED 1
95 #endif
96
97 #if LIBVIR_CHECK_VERSION(1, 2, 11)
98 #define HAVE_FS_INFO 1
99 #endif
100
101 #if LIBVIR_CHECK_VERSION(1, 2, 15)
102 #define HAVE_DOM_REASON_PAUSED_STARTING_UP 1
103 #endif
104
105 #if LIBVIR_CHECK_VERSION(1, 3, 3)
106 #define HAVE_PERF_STATS 1
107 #define HAVE_DOM_REASON_POSTCOPY 1
108 #endif
109
110 #endif /* LIBVIR_CHECK_VERSION */
111
112 /* structure used for aggregating notification-thread data*/
113 typedef struct virt_notif_thread_s {
114   pthread_t event_loop_tid;
115   int domain_event_cb_id;
116   pthread_mutex_t active_mutex; /* protects 'is_active' member access*/
117   bool is_active;
118 } virt_notif_thread_t;
119
120 /* PersistentNotification is false by default */
121 static bool persistent_notification = false;
122
123 static bool report_block_devices = true;
124 static bool report_network_interfaces = true;
125
126 /* Thread used for handling libvirt notifications events */
127 static virt_notif_thread_t notif_thread;
128
129 const char *domain_states[] = {
130         [VIR_DOMAIN_NOSTATE] = "no state",
131         [VIR_DOMAIN_RUNNING] = "the domain is running",
132         [VIR_DOMAIN_BLOCKED] = "the domain is blocked on resource",
133         [VIR_DOMAIN_PAUSED] = "the domain is paused by user",
134         [VIR_DOMAIN_SHUTDOWN] = "the domain is being shut down",
135         [VIR_DOMAIN_SHUTOFF] = "the domain is shut off",
136         [VIR_DOMAIN_CRASHED] = "the domain is crashed",
137 #ifdef HAVE_DOM_STATE_PMSUSPENDED
138         [VIR_DOMAIN_PMSUSPENDED] =
139             "the domain is suspended by guest power management",
140 #endif
141 };
142
143 static int map_domain_event_to_state(int event) {
144   int ret;
145   switch (event) {
146   case VIR_DOMAIN_EVENT_STARTED:
147     ret = VIR_DOMAIN_RUNNING;
148     break;
149   case VIR_DOMAIN_EVENT_SUSPENDED:
150     ret = VIR_DOMAIN_PAUSED;
151     break;
152   case VIR_DOMAIN_EVENT_RESUMED:
153     ret = VIR_DOMAIN_RUNNING;
154     break;
155   case VIR_DOMAIN_EVENT_STOPPED:
156     ret = VIR_DOMAIN_SHUTOFF;
157     break;
158   case VIR_DOMAIN_EVENT_SHUTDOWN:
159     ret = VIR_DOMAIN_SHUTDOWN;
160     break;
161 #ifdef HAVE_DOM_STATE_PMSUSPENDED
162   case VIR_DOMAIN_EVENT_PMSUSPENDED:
163     ret = VIR_DOMAIN_PMSUSPENDED;
164     break;
165 #endif
166 #ifdef HAVE_DOM_REASON_CRASHED
167   case VIR_DOMAIN_EVENT_CRASHED:
168     ret = VIR_DOMAIN_CRASHED;
169     break;
170 #endif
171   default:
172     ret = VIR_DOMAIN_NOSTATE;
173   }
174   return ret;
175 }
176
177 #ifdef HAVE_DOM_REASON
178 static int map_domain_event_detail_to_reason(int event, int detail) {
179   int ret;
180   switch (event) {
181   case VIR_DOMAIN_EVENT_STARTED:
182     switch (detail) {
183     case VIR_DOMAIN_EVENT_STARTED_BOOTED: /* Normal startup from boot */
184       ret = VIR_DOMAIN_RUNNING_BOOTED;
185       break;
186     case VIR_DOMAIN_EVENT_STARTED_MIGRATED: /* Incoming migration from another
187                                                host */
188       ret = VIR_DOMAIN_RUNNING_MIGRATED;
189       break;
190     case VIR_DOMAIN_EVENT_STARTED_RESTORED: /* Restored from a state file */
191       ret = VIR_DOMAIN_RUNNING_RESTORED;
192       break;
193     case VIR_DOMAIN_EVENT_STARTED_FROM_SNAPSHOT: /* Restored from snapshot */
194       ret = VIR_DOMAIN_RUNNING_FROM_SNAPSHOT;
195       break;
196 #ifdef HAVE_DOM_REASON_RUNNING_WAKEUP
197     case VIR_DOMAIN_EVENT_STARTED_WAKEUP: /* Started due to wakeup event */
198       ret = VIR_DOMAIN_RUNNING_WAKEUP;
199       break;
200 #endif
201     default:
202       ret = VIR_DOMAIN_RUNNING_UNKNOWN;
203     }
204     break;
205   case VIR_DOMAIN_EVENT_SUSPENDED:
206     switch (detail) {
207     case VIR_DOMAIN_EVENT_SUSPENDED_PAUSED: /* Normal suspend due to admin
208                                                pause */
209       ret = VIR_DOMAIN_PAUSED_USER;
210       break;
211     case VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED: /* Suspended for offline
212                                                  migration */
213       ret = VIR_DOMAIN_PAUSED_MIGRATION;
214       break;
215     case VIR_DOMAIN_EVENT_SUSPENDED_IOERROR: /* Suspended due to a disk I/O
216                                                 error */
217       ret = VIR_DOMAIN_PAUSED_IOERROR;
218       break;
219     case VIR_DOMAIN_EVENT_SUSPENDED_WATCHDOG: /* Suspended due to a watchdog
220                                                  firing */
221       ret = VIR_DOMAIN_PAUSED_WATCHDOG;
222       break;
223     case VIR_DOMAIN_EVENT_SUSPENDED_RESTORED: /* Restored from paused state
224                                                  file */
225       ret = VIR_DOMAIN_PAUSED_UNKNOWN;
226       break;
227     case VIR_DOMAIN_EVENT_SUSPENDED_FROM_SNAPSHOT: /* Restored from paused
228                                                       snapshot */
229       ret = VIR_DOMAIN_PAUSED_FROM_SNAPSHOT;
230       break;
231     case VIR_DOMAIN_EVENT_SUSPENDED_API_ERROR: /* Suspended after failure during
232                                                   libvirt API call */
233       ret = VIR_DOMAIN_PAUSED_UNKNOWN;
234       break;
235 #ifdef HAVE_DOM_REASON_POSTCOPY
236     case VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY: /* Suspended for post-copy
237                                                  migration */
238       ret = VIR_DOMAIN_PAUSED_POSTCOPY;
239       break;
240     case VIR_DOMAIN_EVENT_SUSPENDED_POSTCOPY_FAILED: /* Suspended after failed
241                                                         post-copy */
242       ret = VIR_DOMAIN_PAUSED_POSTCOPY_FAILED;
243       break;
244 #endif
245     default:
246       ret = VIR_DOMAIN_PAUSED_UNKNOWN;
247     }
248     break;
249   case VIR_DOMAIN_EVENT_RESUMED:
250     switch (detail) {
251     case VIR_DOMAIN_EVENT_RESUMED_UNPAUSED: /* Normal resume due to admin
252                                                unpause */
253       ret = VIR_DOMAIN_RUNNING_UNPAUSED;
254       break;
255     case VIR_DOMAIN_EVENT_RESUMED_MIGRATED: /* Resumed for completion of
256                                                migration */
257       ret = VIR_DOMAIN_RUNNING_MIGRATED;
258       break;
259     case VIR_DOMAIN_EVENT_RESUMED_FROM_SNAPSHOT: /* Resumed from snapshot */
260       ret = VIR_DOMAIN_RUNNING_FROM_SNAPSHOT;
261       break;
262 #ifdef HAVE_DOM_REASON_POSTCOPY
263     case VIR_DOMAIN_EVENT_RESUMED_POSTCOPY: /* Resumed, but migration is still
264                                                running in post-copy mode */
265       ret = VIR_DOMAIN_RUNNING_POSTCOPY;
266       break;
267 #endif
268     default:
269       ret = VIR_DOMAIN_RUNNING_UNKNOWN;
270     }
271     break;
272   case VIR_DOMAIN_EVENT_STOPPED:
273     switch (detail) {
274     case VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN: /* Normal shutdown */
275       ret = VIR_DOMAIN_SHUTOFF_SHUTDOWN;
276       break;
277     case VIR_DOMAIN_EVENT_STOPPED_DESTROYED: /* Forced poweroff from host */
278       ret = VIR_DOMAIN_SHUTOFF_DESTROYED;
279       break;
280     case VIR_DOMAIN_EVENT_STOPPED_CRASHED: /* Guest crashed */
281       ret = VIR_DOMAIN_SHUTOFF_CRASHED;
282       break;
283     case VIR_DOMAIN_EVENT_STOPPED_MIGRATED: /* Migrated off to another host */
284       ret = VIR_DOMAIN_SHUTOFF_MIGRATED;
285       break;
286     case VIR_DOMAIN_EVENT_STOPPED_SAVED: /* Saved to a state file */
287       ret = VIR_DOMAIN_SHUTOFF_SAVED;
288       break;
289     case VIR_DOMAIN_EVENT_STOPPED_FAILED: /* Host emulator/mgmt failed */
290       ret = VIR_DOMAIN_SHUTOFF_FAILED;
291       break;
292     case VIR_DOMAIN_EVENT_STOPPED_FROM_SNAPSHOT: /* Offline snapshot loaded */
293       ret = VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT;
294       break;
295     default:
296       ret = VIR_DOMAIN_SHUTOFF_UNKNOWN;
297     }
298     break;
299   case VIR_DOMAIN_EVENT_SHUTDOWN:
300     switch (detail) {
301     case VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED: /* Guest finished shutdown
302                                                 sequence */
303       ret = VIR_DOMAIN_SHUTDOWN_USER;
304       break;
305     default:
306       ret = VIR_DOMAIN_SHUTDOWN_UNKNOWN;
307     }
308     break;
309 #ifdef HAVE_DOM_STATE_PMSUSPENDED
310   case VIR_DOMAIN_EVENT_PMSUSPENDED:
311     switch (detail) {
312     case VIR_DOMAIN_EVENT_PMSUSPENDED_MEMORY: /* Guest was PM suspended to
313                                                  memory */
314       ret = VIR_DOMAIN_PMSUSPENDED_UNKNOWN;
315       break;
316     case VIR_DOMAIN_EVENT_PMSUSPENDED_DISK: /* Guest was PM suspended to disk */
317       ret = VIR_DOMAIN_PMSUSPENDED_DISK_UNKNOWN;
318       break;
319     default:
320       ret = VIR_DOMAIN_PMSUSPENDED_UNKNOWN;
321     }
322     break;
323 #endif
324   case VIR_DOMAIN_EVENT_CRASHED:
325     switch (detail) {
326     case VIR_DOMAIN_EVENT_CRASHED_PANICKED: /* Guest was panicked */
327       ret = VIR_DOMAIN_CRASHED_PANICKED;
328       break;
329     default:
330       ret = VIR_DOMAIN_CRASHED_UNKNOWN;
331     }
332     break;
333   default:
334     ret = VIR_DOMAIN_NOSTATE_UNKNOWN;
335   }
336   return ret;
337 }
338
339 #define DOMAIN_STATE_REASON_MAX_SIZE 20
340 const char *domain_reasons[][DOMAIN_STATE_REASON_MAX_SIZE] = {
341         [VIR_DOMAIN_NOSTATE][VIR_DOMAIN_NOSTATE_UNKNOWN] =
342             "the reason is unknown",
343
344         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_UNKNOWN] =
345             "the reason is unknown",
346         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_BOOTED] =
347             "normal startup from boot",
348         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_MIGRATED] =
349             "migrated from another host",
350         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_RESTORED] =
351             "restored from a state file",
352         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_FROM_SNAPSHOT] =
353             "restored from snapshot",
354         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_UNPAUSED] =
355             "returned from paused state",
356         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_MIGRATION_CANCELED] =
357             "returned from migration",
358         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_SAVE_CANCELED] =
359             "returned from failed save process",
360 #ifdef HAVE_DOM_REASON_RUNNING_WAKEUP
361         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_WAKEUP] =
362             "returned from pmsuspended due to wakeup event",
363 #endif
364 #ifdef HAVE_DOM_REASON_CRASHED
365         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_CRASHED] =
366             "resumed from crashed",
367 #endif
368 #ifdef HAVE_DOM_REASON_POSTCOPY
369         [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_POSTCOPY] =
370             "running in post-copy migration mode",
371 #endif
372         [VIR_DOMAIN_BLOCKED][VIR_DOMAIN_BLOCKED_UNKNOWN] =
373             "the reason is unknown",
374
375         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_UNKNOWN] =
376             "the reason is unknown",
377         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_USER] = "paused on user request",
378         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_MIGRATION] =
379             "paused for offline migration",
380         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SAVE] = "paused for save",
381         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_DUMP] =
382             "paused for offline core dump",
383         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_IOERROR] =
384             "paused due to a disk I/O error",
385         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_WATCHDOG] =
386             "paused due to a watchdog event",
387         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_FROM_SNAPSHOT] =
388             "paused after restoring from snapshot",
389 #ifdef HAVE_DOM_REASON_PAUSED_SHUTTING_DOWN
390         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SHUTTING_DOWN] =
391             "paused during shutdown process",
392 #endif
393 #ifdef HAVE_DOM_REASON_PAUSED_SNAPSHOT
394         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SNAPSHOT] =
395             "paused while creating a snapshot",
396 #endif
397 #ifdef HAVE_DOM_REASON_PAUSED_CRASHED
398         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_CRASHED] =
399             "paused due to a guest crash",
400 #endif
401 #ifdef HAVE_DOM_REASON_PAUSED_STARTING_UP
402         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_STARTING_UP] =
403             "the domain is being started",
404 #endif
405 #ifdef HAVE_DOM_REASON_POSTCOPY
406         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_POSTCOPY] =
407             "paused for post-copy migration",
408         [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_POSTCOPY_FAILED] =
409             "paused after failed post-copy",
410 #endif
411         [VIR_DOMAIN_SHUTDOWN][VIR_DOMAIN_SHUTDOWN_UNKNOWN] =
412             "the reason is unknown",
413         [VIR_DOMAIN_SHUTDOWN][VIR_DOMAIN_SHUTDOWN_USER] =
414             "shutting down on user request",
415
416         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_UNKNOWN] =
417             "the reason is unknown",
418         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_SHUTDOWN] = "normal shutdown",
419         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_DESTROYED] = "forced poweroff",
420         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_CRASHED] = "domain crashed",
421         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_MIGRATED] =
422             "migrated to another host",
423         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_SAVED] = "saved to a file",
424         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_FAILED] =
425             "domain failed to start",
426         [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT] =
427             "restored from a snapshot which was taken while domain was shutoff",
428
429         [VIR_DOMAIN_CRASHED][VIR_DOMAIN_CRASHED_UNKNOWN] =
430             "the reason is unknown",
431 #ifdef VIR_DOMAIN_CRASHED_PANICKED
432         [VIR_DOMAIN_CRASHED][VIR_DOMAIN_CRASHED_PANICKED] = "domain panicked",
433 #endif
434
435 #ifdef HAVE_DOM_STATE_PMSUSPENDED
436         [VIR_DOMAIN_PMSUSPENDED][VIR_DOMAIN_PMSUSPENDED_UNKNOWN] =
437             "the reason is unknown",
438 #endif
439 };
440 #endif /* HAVE_DOM_REASON */
441
442 #define NANOSEC_IN_SEC 1e9
443
444 #define GET_STATS(_f, _name, ...)                                              \
445   do {                                                                         \
446     status = _f(__VA_ARGS__);                                                  \
447     if (status != 0)                                                           \
448       ERROR(PLUGIN_NAME " plugin: Failed to get " _name);                      \
449   } while (0)
450
451 /* Connection. */
452 static virConnectPtr conn;
453 static char *conn_string;
454 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
455
456 /* Node information required for %CPU */
457 static virNodeInfo nodeinfo;
458
459 /* Seconds between list refreshes, 0 disables completely. */
460 static int interval = 60;
461
462 /* List of domains, if specified. */
463 static ignorelist_t *il_domains;
464 /* List of block devices, if specified. */
465 static ignorelist_t *il_block_devices;
466 /* List of network interface devices, if specified. */
467 static ignorelist_t *il_interface_devices;
468
469 static int ignore_device_match(ignorelist_t *, const char *domname,
470                                const char *devpath);
471
472 /* Actual list of block devices found on last refresh. */
473 struct block_device {
474   virDomainPtr dom; /* domain */
475   char *path;       /* name of block device */
476   bool has_source;  /* information whether source is defined or not */
477 };
478
479 /* Actual list of network interfaces found on last refresh. */
480 struct interface_device {
481   virDomainPtr dom; /* domain */
482   char *path;       /* name of interface device */
483   char *address;    /* mac address of interface device */
484   char *number;     /* interface device number */
485 };
486
487 typedef struct domain_s {
488   virDomainPtr ptr;
489   virDomainInfo info;
490   bool active;
491 } domain_t;
492
493 struct lv_read_state {
494   /* Actual list of domains found on last refresh. */
495   domain_t *domains;
496   int nr_domains;
497
498   struct block_device *block_devices;
499   int nr_block_devices;
500
501   struct interface_device *interface_devices;
502   int nr_interface_devices;
503 };
504
505 static void free_domains(struct lv_read_state *state);
506 static int add_domain(struct lv_read_state *state, virDomainPtr dom,
507                       bool active);
508
509 static void free_block_devices(struct lv_read_state *state);
510 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
511                             const char *path, bool has_source);
512
513 static void free_interface_devices(struct lv_read_state *state);
514 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
515                                 const char *path, const char *address,
516                                 unsigned int number);
517
518 #define METADATA_VM_PARTITION_URI "http://ovirt.org/ovirtmap/tag/1.0"
519 #define METADATA_VM_PARTITION_ELEMENT "tag"
520 #define METADATA_VM_PARTITION_PREFIX "ovirtmap"
521
522 #define BUFFER_MAX_LEN 256
523 #define PARTITION_TAG_MAX_LEN 32
524
525 struct lv_read_instance {
526   struct lv_read_state read_state;
527   char tag[PARTITION_TAG_MAX_LEN];
528   size_t id;
529 };
530
531 struct lv_user_data {
532   struct lv_read_instance inst;
533   user_data_t ud;
534 };
535
536 #define NR_INSTANCES_DEFAULT 1
537 #define NR_INSTANCES_MAX 128
538 static int nr_instances = NR_INSTANCES_DEFAULT;
539 static struct lv_user_data lv_read_user_data[NR_INSTANCES_MAX];
540
541 /* HostnameFormat. */
542 #define HF_MAX_FIELDS 4
543
544 enum hf_field { hf_none = 0, hf_hostname, hf_name, hf_uuid, hf_metadata };
545
546 static enum hf_field hostname_format[HF_MAX_FIELDS] = {hf_name};
547
548 /* PluginInstanceFormat */
549 #define PLGINST_MAX_FIELDS 3
550
551 enum plginst_field {
552   plginst_none = 0,
553   plginst_name,
554   plginst_uuid,
555   plginst_metadata
556 };
557
558 static enum plginst_field plugin_instance_format[PLGINST_MAX_FIELDS] = {
559     plginst_none};
560
561 /* HostnameMetadataNS && HostnameMetadataXPath */
562 static char *hm_xpath;
563 static char *hm_ns;
564
565 /* BlockDeviceFormat */
566 enum bd_field { target, source };
567
568 /* InterfaceFormat. */
569 enum if_field { if_address, if_name, if_number };
570
571 /* ExtraStats */
572 #define EX_STATS_MAX_FIELDS 15
573 enum ex_stats {
574   ex_stats_none = 0,
575   ex_stats_disk = 1 << 0,
576   ex_stats_pcpu = 1 << 1,
577   ex_stats_cpu_util = 1 << 2,
578   ex_stats_domain_state = 1 << 3,
579 #ifdef HAVE_PERF_STATS
580   ex_stats_perf = 1 << 4,
581 #endif
582   ex_stats_vcpupin = 1 << 5,
583 #ifdef HAVE_DISK_ERR
584   ex_stats_disk_err = 1 << 6,
585 #endif
586 #ifdef HAVE_FS_INFO
587   ex_stats_fs_info = 1 << 7,
588 #endif
589 #ifdef HAVE_JOB_STATS
590   ex_stats_job_stats_completed = 1 << 8,
591   ex_stats_job_stats_background = 1 << 9,
592 #endif
593   ex_stats_disk_allocation = 1 << 10,
594   ex_stats_disk_capacity = 1 << 11,
595   ex_stats_disk_physical = 1 << 12
596 };
597
598 static unsigned int extra_stats = ex_stats_none;
599
600 struct ex_stats_item {
601   const char *name;
602   enum ex_stats flag;
603 };
604 static const struct ex_stats_item ex_stats_table[] = {
605     {"disk", ex_stats_disk},
606     {"pcpu", ex_stats_pcpu},
607     {"cpu_util", ex_stats_cpu_util},
608     {"domain_state", ex_stats_domain_state},
609 #ifdef HAVE_PERF_STATS
610     {"perf", ex_stats_perf},
611 #endif
612     {"vcpupin", ex_stats_vcpupin},
613 #ifdef HAVE_DISK_ERR
614     {"disk_err", ex_stats_disk_err},
615 #endif
616 #ifdef HAVE_FS_INFO
617     {"fs_info", ex_stats_fs_info},
618 #endif
619 #ifdef HAVE_JOB_STATS
620     {"job_stats_completed", ex_stats_job_stats_completed},
621     {"job_stats_background", ex_stats_job_stats_background},
622 #endif
623     {"disk_allocation", ex_stats_disk_allocation},
624     {"disk_capacity", ex_stats_disk_capacity},
625     {"disk_physical", ex_stats_disk_physical},
626     {NULL, ex_stats_none},
627 };
628
629 /* BlockDeviceFormatBasename */
630 static bool blockdevice_format_basename;
631 static enum bd_field blockdevice_format = target;
632 static enum if_field interface_format = if_name;
633
634 /* Time that we last refreshed. */
635 static time_t last_refresh = (time_t)0;
636
637 static int refresh_lists(struct lv_read_instance *inst);
638
639 struct lv_block_stats {
640   virDomainBlockStatsStruct bi;
641
642   long long rd_total_times;
643   long long wr_total_times;
644
645   long long fl_req;
646   long long fl_total_times;
647 };
648
649 static void init_block_stats(struct lv_block_stats *bstats) {
650   if (bstats == NULL)
651     return;
652
653   bstats->bi.rd_req = -1;
654   bstats->bi.wr_req = -1;
655   bstats->bi.rd_bytes = -1;
656   bstats->bi.wr_bytes = -1;
657
658   bstats->rd_total_times = -1;
659   bstats->wr_total_times = -1;
660   bstats->fl_req = -1;
661   bstats->fl_total_times = -1;
662 }
663
664 static void init_block_info(virDomainBlockInfoPtr binfo) {
665   binfo->allocation = -1;
666   binfo->capacity = -1;
667   binfo->physical = -1;
668 }
669
670 #ifdef HAVE_BLOCK_STATS_FLAGS
671
672 #define GET_BLOCK_STATS_VALUE(NAME, FIELD)                                     \
673   if (!strcmp(param[i].field, NAME)) {                                         \
674     bstats->FIELD = param[i].value.l;                                          \
675     continue;                                                                  \
676   }
677
678 static int get_block_stats(struct lv_block_stats *bstats,
679                            virTypedParameterPtr param, int nparams) {
680   if (bstats == NULL || param == NULL)
681     return -1;
682
683   for (int i = 0; i < nparams; ++i) {
684     /* ignore type. Everything must be LLONG anyway. */
685     GET_BLOCK_STATS_VALUE("rd_operations", bi.rd_req);
686     GET_BLOCK_STATS_VALUE("wr_operations", bi.wr_req);
687     GET_BLOCK_STATS_VALUE("rd_bytes", bi.rd_bytes);
688     GET_BLOCK_STATS_VALUE("wr_bytes", bi.wr_bytes);
689     GET_BLOCK_STATS_VALUE("rd_total_times", rd_total_times);
690     GET_BLOCK_STATS_VALUE("wr_total_times", wr_total_times);
691     GET_BLOCK_STATS_VALUE("flush_operations", fl_req);
692     GET_BLOCK_STATS_VALUE("flush_total_times", fl_total_times);
693   }
694
695   return 0;
696 }
697
698 #undef GET_BLOCK_STATS_VALUE
699
700 #endif /* HAVE_BLOCK_STATS_FLAGS */
701
702 /* ERROR(...) macro for virterrors. */
703 #define VIRT_ERROR(conn, s)                                                    \
704   do {                                                                         \
705     virErrorPtr err;                                                           \
706     err = (conn) ? virConnGetLastError((conn)) : virGetLastError();            \
707     if (err)                                                                   \
708       ERROR(PLUGIN_NAME " plugin: %s failed: %s", (s), err->message);          \
709   } while (0)
710
711 static char *metadata_get_hostname(virDomainPtr dom) {
712   const char *xpath_str = NULL;
713   if (hm_xpath == NULL)
714     xpath_str = "/instance/name/text()";
715   else
716     xpath_str = hm_xpath;
717
718   const char *namespace = NULL;
719   if (hm_ns == NULL) {
720     namespace = "http://openstack.org/xmlns/libvirt/nova/1.0";
721   } else {
722     namespace = hm_ns;
723   }
724
725   char *metadata_str = virDomainGetMetadata(
726       dom, VIR_DOMAIN_METADATA_ELEMENT, namespace, VIR_DOMAIN_AFFECT_CURRENT);
727   if (metadata_str == NULL) {
728     return NULL;
729   }
730
731   char *hostname = NULL;
732   xmlXPathContextPtr xpath_ctx = NULL;
733   xmlXPathObjectPtr xpath_obj = NULL;
734   xmlNodePtr xml_node = NULL;
735
736   xmlDocPtr xml_doc =
737       xmlReadDoc((xmlChar *)metadata_str, NULL, NULL, XML_PARSE_NONET);
738   if (xml_doc == NULL) {
739     ERROR(PLUGIN_NAME " plugin: xmlReadDoc failed to read metadata");
740     goto metadata_end;
741   }
742
743   xpath_ctx = xmlXPathNewContext(xml_doc);
744   if (xpath_ctx == NULL) {
745     ERROR(PLUGIN_NAME " plugin: xmlXPathNewContext(%s) failed for metadata",
746           metadata_str);
747     goto metadata_end;
748   }
749   xpath_obj = xmlXPathEval((xmlChar *)xpath_str, xpath_ctx);
750   if (xpath_obj == NULL) {
751     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed for metadata",
752           xpath_str);
753     goto metadata_end;
754   }
755
756   if (xpath_obj->type != XPATH_NODESET) {
757     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
758                       "(wanted %d) for metadata",
759           xpath_str, xpath_obj->type, XPATH_NODESET);
760     goto metadata_end;
761   }
762
763   // TODO(sileht): We can support || operator by looping on nodes here
764   if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
765     WARNING(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
766                         "expected=1 for metadata",
767             xpath_str,
768             (xpath_obj->nodesetval == NULL) ? 0
769                                             : xpath_obj->nodesetval->nodeNr);
770     goto metadata_end;
771   }
772
773   xml_node = xpath_obj->nodesetval->nodeTab[0];
774   if (xml_node->type == XML_TEXT_NODE) {
775     hostname = strdup((const char *)xml_node->content);
776   } else if (xml_node->type == XML_ATTRIBUTE_NODE) {
777     hostname = strdup((const char *)xml_node->children->content);
778   } else {
779     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unsupported node type %d",
780           xpath_str, xml_node->type);
781     goto metadata_end;
782   }
783
784   if (hostname == NULL) {
785     ERROR(PLUGIN_NAME " plugin: strdup(%s) hostname failed", xpath_str);
786     goto metadata_end;
787   }
788
789 metadata_end:
790   if (xpath_obj)
791     xmlXPathFreeObject(xpath_obj);
792   if (xpath_ctx)
793     xmlXPathFreeContext(xpath_ctx);
794   if (xml_doc)
795     xmlFreeDoc(xml_doc);
796   sfree(metadata_str);
797   return hostname;
798 }
799
800 static void init_value_list(value_list_t *vl, virDomainPtr dom) {
801   const char *name;
802   char uuid[VIR_UUID_STRING_BUFLEN];
803
804   sstrncpy(vl->plugin, PLUGIN_NAME, sizeof(vl->plugin));
805
806   vl->host[0] = '\0';
807
808   /* Construct the hostname field according to HostnameFormat. */
809   for (int i = 0; i < HF_MAX_FIELDS; ++i) {
810     if (hostname_format[i] == hf_none)
811       continue;
812
813     if (i > 0)
814       SSTRNCAT(vl->host, ":", sizeof(vl->host));
815
816     switch (hostname_format[i]) {
817     case hf_none:
818       break;
819     case hf_hostname:
820       SSTRNCAT(vl->host, hostname_g, sizeof(vl->host));
821       break;
822     case hf_name:
823       name = virDomainGetName(dom);
824       if (name)
825         SSTRNCAT(vl->host, name, sizeof(vl->host));
826       break;
827     case hf_uuid:
828       if (virDomainGetUUIDString(dom, uuid) == 0)
829         SSTRNCAT(vl->host, uuid, sizeof(vl->host));
830       break;
831     case hf_metadata:
832       name = metadata_get_hostname(dom);
833       if (name)
834         SSTRNCAT(vl->host, name, sizeof(vl->host));
835       break;
836     }
837   }
838
839   /* Construct the plugin instance field according to PluginInstanceFormat. */
840   for (int i = 0; i < PLGINST_MAX_FIELDS; ++i) {
841     if (plugin_instance_format[i] == plginst_none)
842       continue;
843
844     if (i > 0)
845       SSTRNCAT(vl->plugin_instance, ":", sizeof(vl->plugin_instance));
846
847     switch (plugin_instance_format[i]) {
848     case plginst_none:
849       break;
850     case plginst_name:
851       name = virDomainGetName(dom);
852       if (name)
853         SSTRNCAT(vl->plugin_instance, name, sizeof(vl->plugin_instance));
854       break;
855     case plginst_uuid:
856       if (virDomainGetUUIDString(dom, uuid) == 0)
857         SSTRNCAT(vl->plugin_instance, uuid, sizeof(vl->plugin_instance));
858       break;
859     case plginst_metadata:
860       name = metadata_get_hostname(dom);
861       if (name)
862         SSTRNCAT(vl->plugin_instance, name, sizeof(vl->plugin_instance));
863       break;
864     }
865   }
866
867 } /* void init_value_list */
868
869 static int init_notif(notification_t *notif, const virDomainPtr domain,
870                       int severity, const char *msg, const char *type,
871                       const char *type_instance) {
872   value_list_t vl = VALUE_LIST_INIT;
873
874   if (!notif) {
875     ERROR(PLUGIN_NAME " plugin: init_notif: NULL pointer");
876     return -1;
877   }
878
879   init_value_list(&vl, domain);
880   notification_init(notif, severity, msg, vl.host, vl.plugin,
881                     vl.plugin_instance, type, type_instance);
882   notif->time = cdtime();
883   return 0;
884 }
885
886 static void submit_notif(const virDomainPtr domain, int severity,
887                          const char *msg, const char *type,
888                          const char *type_instance) {
889   notification_t notif;
890
891   init_notif(&notif, domain, severity, msg, type, type_instance);
892   plugin_dispatch_notification(&notif);
893   if (notif.meta)
894     plugin_notification_meta_free(notif.meta);
895 }
896
897 static void submit(virDomainPtr dom, char const *type,
898                    char const *type_instance, value_t *values,
899                    size_t values_len) {
900   value_list_t vl = VALUE_LIST_INIT;
901   init_value_list(&vl, dom);
902
903   vl.values = values;
904   vl.values_len = values_len;
905
906   sstrncpy(vl.type, type, sizeof(vl.type));
907   if (type_instance != NULL)
908     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
909
910   plugin_dispatch_values(&vl);
911 }
912
913 static void memory_submit(virDomainPtr dom, gauge_t value) {
914   submit(dom, "memory", "total", &(value_t){.gauge = value}, 1);
915 }
916
917 static void memory_stats_submit(gauge_t value, virDomainPtr dom,
918                                 int tag_index) {
919   static const char *tags[] = {"swap_in",        "swap_out", "major_fault",
920                                "minor_fault",    "unused",   "available",
921                                "actual_balloon", "rss",      "usable",
922                                "last_update"};
923
924   if ((tag_index < 0) || (tag_index >= (int)STATIC_ARRAY_SIZE(tags))) {
925     ERROR("virt plugin: Array index out of bounds: tag_index = %d", tag_index);
926     return;
927   }
928
929   /* Skip 'last_update' reporting as that is not memory but timestamp */
930   if (tag_index == 9)
931     return;
932
933   submit(dom, "memory", tags[tag_index], &(value_t){.gauge = value}, 1);
934 }
935
936 static void submit_derive2(const char *type, derive_t v0, derive_t v1,
937                            virDomainPtr dom, const char *devname) {
938   value_t values[] = {
939       {.derive = v0}, {.derive = v1},
940   };
941
942   submit(dom, type, devname, values, STATIC_ARRAY_SIZE(values));
943 } /* void submit_derive2 */
944
945 static double cpu_ns_to_percent(unsigned int node_cpus,
946                                 unsigned long long cpu_time_old,
947                                 unsigned long long cpu_time_new) {
948   double percent = 0.0;
949   unsigned long long cpu_time_diff = 0;
950   double time_diff_sec = CDTIME_T_TO_DOUBLE(plugin_get_interval());
951
952   if (node_cpus != 0 && time_diff_sec != 0 && cpu_time_old != 0) {
953     cpu_time_diff = cpu_time_new - cpu_time_old;
954     percent = ((double)(100 * cpu_time_diff)) /
955               (time_diff_sec * node_cpus * NANOSEC_IN_SEC);
956   }
957
958   DEBUG(PLUGIN_NAME " plugin: node_cpus=%u cpu_time_old=%" PRIu64
959                     " cpu_time_new=%" PRIu64 "cpu_time_diff=%" PRIu64
960                     " time_diff_sec=%f percent=%f",
961         node_cpus, (uint64_t)cpu_time_old, (uint64_t)cpu_time_new,
962         (uint64_t)cpu_time_diff, time_diff_sec, percent);
963
964   return percent;
965 }
966
967 static void cpu_submit(const domain_t *dom, unsigned long long cpuTime_new) {
968
969   if (!dom)
970     return;
971
972   if (extra_stats & ex_stats_cpu_util) {
973     /* Computing %CPU requires 2 samples of cpuTime */
974     if (dom->info.cpuTime != 0 && cpuTime_new != 0) {
975
976       submit(dom->ptr, "percent", "virt_cpu_total",
977              &(value_t){.gauge = cpu_ns_to_percent(
978                             nodeinfo.cpus, dom->info.cpuTime, cpuTime_new)},
979              1);
980     }
981   }
982
983   submit(dom->ptr, "virt_cpu_total", NULL, &(value_t){.derive = cpuTime_new},
984          1);
985 }
986
987 static void vcpu_submit(derive_t value, virDomainPtr dom, int vcpu_nr,
988                         const char *type) {
989   char type_instance[DATA_MAX_NAME_LEN];
990
991   snprintf(type_instance, sizeof(type_instance), "%d", vcpu_nr);
992   submit(dom, type, type_instance, &(value_t){.derive = value}, 1);
993 }
994
995 static void disk_block_stats_submit(struct lv_block_stats *bstats,
996                                     virDomainPtr dom, const char *dev,
997                                     virDomainBlockInfoPtr binfo) {
998   char *dev_copy = strdup(dev);
999   const char *type_instance = dev_copy;
1000
1001   if (!dev_copy)
1002     return;
1003
1004   if (blockdevice_format_basename && blockdevice_format == source)
1005     type_instance = basename(dev_copy);
1006
1007   if (!type_instance) {
1008     sfree(dev_copy);
1009     return;
1010   }
1011
1012   char flush_type_instance[DATA_MAX_NAME_LEN];
1013   snprintf(flush_type_instance, sizeof(flush_type_instance), "flush-%s",
1014            type_instance);
1015
1016   if ((bstats->bi.rd_req != -1) && (bstats->bi.wr_req != -1))
1017     submit_derive2("disk_ops", (derive_t)bstats->bi.rd_req,
1018                    (derive_t)bstats->bi.wr_req, dom, type_instance);
1019
1020   if ((bstats->bi.rd_bytes != -1) && (bstats->bi.wr_bytes != -1))
1021     submit_derive2("disk_octets", (derive_t)bstats->bi.rd_bytes,
1022                    (derive_t)bstats->bi.wr_bytes, dom, type_instance);
1023
1024   if (extra_stats & ex_stats_disk) {
1025     if ((bstats->rd_total_times != -1) && (bstats->wr_total_times != -1))
1026       submit_derive2("disk_time", (derive_t)bstats->rd_total_times,
1027                      (derive_t)bstats->wr_total_times, dom, type_instance);
1028
1029     if (bstats->fl_req != -1)
1030       submit(dom, "total_requests", flush_type_instance,
1031              &(value_t){.derive = (derive_t)bstats->fl_req}, 1);
1032     if (bstats->fl_total_times != -1) {
1033       derive_t value = bstats->fl_total_times / 1000; // ns -> ms
1034       submit(dom, "total_time_in_ms", flush_type_instance,
1035              &(value_t){.derive = value}, 1);
1036     }
1037   }
1038
1039   /* disk_allocation, disk_capacity and disk_physical are stored only
1040    * if corresponding extrastats are set in collectd configuration file */
1041   if ((extra_stats & ex_stats_disk_allocation) && binfo->allocation != -1)
1042     submit(dom, "disk_allocation", type_instance,
1043            &(value_t){.gauge = (gauge_t)binfo->allocation}, 1);
1044
1045   if ((extra_stats & ex_stats_disk_capacity) && binfo->capacity != -1)
1046     submit(dom, "disk_capacity", type_instance,
1047            &(value_t){.gauge = (gauge_t)binfo->capacity}, 1);
1048
1049   if ((extra_stats & ex_stats_disk_physical) && binfo->physical != -1)
1050     submit(dom, "disk_physical", type_instance,
1051            &(value_t){.gauge = (gauge_t)binfo->physical}, 1);
1052
1053   sfree(dev_copy);
1054 }
1055
1056 /**
1057  * Function for parsing ExtraStats configuration options.
1058  * Result of parsing is stored under 'out_parsed_flags' pointer.
1059  *
1060  * Returns 0 in case of success and 1 in case of parsing error
1061  */
1062 static int parse_ex_stats_flags(unsigned int *out_parsed_flags, char **exstats,
1063                                 int numexstats) {
1064   unsigned int ex_stats_flags = ex_stats_none;
1065
1066   assert(out_parsed_flags != NULL);
1067
1068   for (int i = 0; i < numexstats; i++) {
1069     for (int j = 0; ex_stats_table[j].name != NULL; j++) {
1070       if (strcasecmp(exstats[i], ex_stats_table[j].name) == 0) {
1071         DEBUG(PLUGIN_NAME " plugin: enabling extra stats for '%s'",
1072               ex_stats_table[j].name);
1073         ex_stats_flags |= ex_stats_table[j].flag;
1074         break;
1075       }
1076
1077       if (ex_stats_table[j + 1].name == NULL) {
1078         ERROR(PLUGIN_NAME " plugin: Unmatched ExtraStats option: %s",
1079               exstats[i]);
1080         return 1;
1081       }
1082     }
1083   }
1084
1085   *out_parsed_flags = ex_stats_flags;
1086   return 0;
1087 }
1088
1089 static void domain_state_submit_notif(virDomainPtr dom, int state, int reason) {
1090   if ((state < 0) || ((size_t)state >= STATIC_ARRAY_SIZE(domain_states))) {
1091     ERROR(PLUGIN_NAME " plugin: Array index out of bounds: state=%d", state);
1092     return;
1093   }
1094
1095   char msg[DATA_MAX_NAME_LEN];
1096   const char *state_str = domain_states[state];
1097 #ifdef HAVE_DOM_REASON
1098   if ((reason < 0) ||
1099       ((size_t)reason >= STATIC_ARRAY_SIZE(domain_reasons[0]))) {
1100     ERROR(PLUGIN_NAME " plugin: Array index out of bounds: reason=%d", reason);
1101     return;
1102   }
1103
1104   const char *reason_str = domain_reasons[state][reason];
1105   /* Array size for domain reasons is fixed, but different domain states can
1106    * have different number of reasons. We need to check if reason was
1107    * successfully parsed */
1108   if (!reason_str) {
1109     ERROR(PLUGIN_NAME " plugin: Invalid reason (%d) for domain state: %s",
1110           reason, state_str);
1111     return;
1112   }
1113 #else
1114   const char *reason_str = "N/A";
1115 #endif
1116
1117   snprintf(msg, sizeof(msg), "Domain state: %s. Reason: %s", state_str,
1118            reason_str);
1119
1120   int severity;
1121   switch (state) {
1122   case VIR_DOMAIN_NOSTATE:
1123   case VIR_DOMAIN_RUNNING:
1124   case VIR_DOMAIN_SHUTDOWN:
1125   case VIR_DOMAIN_SHUTOFF:
1126     severity = NOTIF_OKAY;
1127     break;
1128   case VIR_DOMAIN_BLOCKED:
1129   case VIR_DOMAIN_PAUSED:
1130 #ifdef DOM_STATE_PMSUSPENDED
1131   case VIR_DOMAIN_PMSUSPENDED:
1132 #endif
1133     severity = NOTIF_WARNING;
1134     break;
1135   case VIR_DOMAIN_CRASHED:
1136     severity = NOTIF_FAILURE;
1137     break;
1138   default:
1139     ERROR(PLUGIN_NAME " plugin: Unrecognized domain state (%d)", state);
1140     return;
1141   }
1142   submit_notif(dom, severity, msg, "domain_state", NULL);
1143 }
1144
1145 static int lv_init_ignorelists() {
1146   if (il_domains == NULL)
1147     il_domains = ignorelist_create(1);
1148   if (il_block_devices == NULL)
1149     il_block_devices = ignorelist_create(1);
1150   if (il_interface_devices == NULL)
1151     il_interface_devices = ignorelist_create(1);
1152
1153   if (!il_domains || !il_block_devices || !il_interface_devices)
1154     return 1;
1155
1156   return 0;
1157 }
1158
1159 /* Validates config option that may take multiple strings arguments.
1160  * Returns 0 on success, -1 otherwise */
1161 static int check_config_multiple_string_entry(const oconfig_item_t *ci) {
1162   if (ci == NULL) {
1163     ERROR(PLUGIN_NAME " plugin: ci oconfig_item can't be NULL");
1164     return -1;
1165   }
1166
1167   if (ci->values_num < 1) {
1168     ERROR(PLUGIN_NAME
1169           " plugin: the '%s' option requires at least one string argument",
1170           ci->key);
1171     return -1;
1172   }
1173
1174   for (int i = 0; i < ci->values_num; ++i) {
1175     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
1176       ERROR(PLUGIN_NAME
1177             " plugin: one of the '%s' options is not a valid string",
1178             ci->key);
1179       return -1;
1180     }
1181   }
1182
1183   return 0;
1184 }
1185
1186 static int lv_config(oconfig_item_t *ci) {
1187   if (lv_init_ignorelists() != 0) {
1188     ERROR(PLUGIN_NAME " plugin: lv_init_ignorelist failed.");
1189     return -1;
1190   }
1191
1192   for (int i = 0; i < ci->children_num; ++i) {
1193     oconfig_item_t *c = ci->children + i;
1194
1195     if (strcasecmp(c->key, "Connection") == 0) {
1196       if (cf_util_get_string(c, &conn_string) != 0 || conn_string == NULL)
1197         return -1;
1198
1199       continue;
1200     } else if (strcasecmp(c->key, "RefreshInterval") == 0) {
1201       if (cf_util_get_int(c, &interval) != 0)
1202         return -1;
1203
1204       continue;
1205     } else if (strcasecmp(c->key, "Domain") == 0) {
1206       char *domain_name = NULL;
1207       if (cf_util_get_string(c, &domain_name) != 0)
1208         return -1;
1209
1210       if (ignorelist_add(il_domains, domain_name)) {
1211         ERROR(PLUGIN_NAME " plugin: Adding '%s' to domain-ignorelist failed",
1212               domain_name);
1213         sfree(domain_name);
1214         return -1;
1215       }
1216
1217       sfree(domain_name);
1218       continue;
1219     } else if (strcasecmp(c->key, "BlockDevice") == 0) {
1220       char *device_name = NULL;
1221       if (cf_util_get_string(c, &device_name) != 0)
1222         return -1;
1223
1224       if (ignorelist_add(il_block_devices, device_name) != 0) {
1225         ERROR(PLUGIN_NAME
1226               " plugin: Adding '%s' to block-device-ignorelist failed",
1227               device_name);
1228         sfree(device_name);
1229         return -1;
1230       }
1231
1232       sfree(device_name);
1233       continue;
1234     } else if (strcasecmp(c->key, "BlockDeviceFormat") == 0) {
1235       char *device_format = NULL;
1236       if (cf_util_get_string(c, &device_format) != 0)
1237         return -1;
1238
1239       if (strcasecmp(device_format, "target") == 0)
1240         blockdevice_format = target;
1241       else if (strcasecmp(device_format, "source") == 0)
1242         blockdevice_format = source;
1243       else {
1244         ERROR(PLUGIN_NAME " plugin: unknown BlockDeviceFormat: %s",
1245               device_format);
1246         sfree(device_format);
1247         return -1;
1248       }
1249
1250       sfree(device_format);
1251       continue;
1252     } else if (strcasecmp(c->key, "BlockDeviceFormatBasename") == 0) {
1253       if (cf_util_get_boolean(c, &blockdevice_format_basename) != 0)
1254         return -1;
1255
1256       continue;
1257     } else if (strcasecmp(c->key, "InterfaceDevice") == 0) {
1258       char *interface_name = NULL;
1259       if (cf_util_get_string(c, &interface_name) != 0)
1260         return -1;
1261
1262       if (ignorelist_add(il_interface_devices, interface_name)) {
1263         ERROR(PLUGIN_NAME " plugin: Adding '%s' to interface-ignorelist failed",
1264               interface_name);
1265         sfree(interface_name);
1266         return -1;
1267       }
1268
1269       sfree(interface_name);
1270       continue;
1271     } else if (strcasecmp(c->key, "IgnoreSelected") == 0) {
1272       bool ignore_selected = false;
1273       if (cf_util_get_boolean(c, &ignore_selected) != 0)
1274         return -1;
1275
1276       if (ignore_selected) {
1277         ignorelist_set_invert(il_domains, 0);
1278         ignorelist_set_invert(il_block_devices, 0);
1279         ignorelist_set_invert(il_interface_devices, 0);
1280       } else {
1281         ignorelist_set_invert(il_domains, 1);
1282         ignorelist_set_invert(il_block_devices, 1);
1283         ignorelist_set_invert(il_interface_devices, 1);
1284       }
1285
1286       continue;
1287     } else if (strcasecmp(c->key, "HostnameMetadataNS") == 0) {
1288       if (cf_util_get_string(c, &hm_ns) != 0)
1289         return -1;
1290
1291       continue;
1292     } else if (strcasecmp(c->key, "HostnameMetadataXPath") == 0) {
1293       if (cf_util_get_string(c, &hm_xpath) != 0)
1294         return -1;
1295
1296       continue;
1297     } else if (strcasecmp(c->key, "HostnameFormat") == 0) {
1298       /* this option can take multiple strings arguments in one config line*/
1299       if (check_config_multiple_string_entry(c) != 0) {
1300         ERROR(PLUGIN_NAME " plugin: Could not get 'HostnameFormat' parameter");
1301         return -1;
1302       }
1303
1304       const int params_num = c->values_num;
1305       for (int i = 0; i < params_num; ++i) {
1306         const char *param_name = c->values[i].value.string;
1307         if (strcasecmp(param_name, "hostname") == 0)
1308           hostname_format[i] = hf_hostname;
1309         else if (strcasecmp(param_name, "name") == 0)
1310           hostname_format[i] = hf_name;
1311         else if (strcasecmp(param_name, "uuid") == 0)
1312           hostname_format[i] = hf_uuid;
1313         else if (strcasecmp(param_name, "metadata") == 0)
1314           hostname_format[i] = hf_metadata;
1315         else {
1316           ERROR(PLUGIN_NAME " plugin: unknown HostnameFormat field: %s",
1317                 param_name);
1318           return -1;
1319         }
1320       }
1321
1322       for (int i = params_num; i < HF_MAX_FIELDS; ++i)
1323         hostname_format[i] = hf_none;
1324
1325       continue;
1326     } else if (strcasecmp(c->key, "PluginInstanceFormat") == 0) {
1327       /* this option can handle list of string parameters in one line*/
1328       if (check_config_multiple_string_entry(c) != 0) {
1329         ERROR(PLUGIN_NAME
1330               " plugin: Could not get 'PluginInstanceFormat' parameter");
1331         return -1;
1332       }
1333
1334       const int params_num = c->values_num;
1335       for (int i = 0; i < params_num; ++i) {
1336         const char *param_name = c->values[i].value.string;
1337         if (strcasecmp(param_name, "none") == 0) {
1338           plugin_instance_format[i] = plginst_none;
1339           break;
1340         } else if (strcasecmp(param_name, "name") == 0)
1341           plugin_instance_format[i] = plginst_name;
1342         else if (strcasecmp(param_name, "uuid") == 0)
1343           plugin_instance_format[i] = plginst_uuid;
1344         else if (strcasecmp(param_name, "metadata") == 0)
1345           plugin_instance_format[i] = plginst_metadata;
1346         else {
1347           ERROR(PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s",
1348                 param_name);
1349
1350           return -1;
1351         }
1352       }
1353
1354       for (int i = params_num; i < PLGINST_MAX_FIELDS; ++i)
1355         plugin_instance_format[i] = plginst_none;
1356
1357       continue;
1358     } else if (strcasecmp(c->key, "InterfaceFormat") == 0) {
1359       char *format = NULL;
1360       if (cf_util_get_string(c, &format) != 0)
1361         return -1;
1362
1363       if (strcasecmp(format, "name") == 0)
1364         interface_format = if_name;
1365       else if (strcasecmp(format, "address") == 0)
1366         interface_format = if_address;
1367       else if (strcasecmp(format, "number") == 0)
1368         interface_format = if_number;
1369       else {
1370         ERROR(PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", format);
1371         sfree(format);
1372         return -1;
1373       }
1374
1375       sfree(format);
1376       continue;
1377     } else if (strcasecmp(c->key, "Instances") == 0) {
1378       if (cf_util_get_int(c, &nr_instances) != 0)
1379         return -1;
1380
1381       if (nr_instances <= 0) {
1382         ERROR(PLUGIN_NAME " plugin: Instances <= 0 makes no sense.");
1383         return -1;
1384       }
1385       if (nr_instances > NR_INSTANCES_MAX) {
1386         ERROR(PLUGIN_NAME " plugin: Instances=%i > NR_INSTANCES_MAX=%i"
1387                           " use a lower setting or recompile the plugin.",
1388               nr_instances, NR_INSTANCES_MAX);
1389         return -1;
1390       }
1391
1392       DEBUG(PLUGIN_NAME " plugin: configured %i instances", nr_instances);
1393       continue;
1394     } else if (strcasecmp(c->key, "ExtraStats") == 0) {
1395       char *ex_str = NULL;
1396
1397       if (cf_util_get_string(c, &ex_str) != 0)
1398         return -1;
1399
1400       char *exstats[EX_STATS_MAX_FIELDS];
1401       int numexstats = strsplit(ex_str, exstats, STATIC_ARRAY_SIZE(exstats));
1402       int status = parse_ex_stats_flags(&extra_stats, exstats, numexstats);
1403       sfree(ex_str);
1404       if (status != 0) {
1405         ERROR(PLUGIN_NAME " plugin: parsing 'ExtraStats' option failed");
1406         return status;
1407       }
1408
1409 #ifdef HAVE_JOB_STATS
1410       if ((extra_stats & ex_stats_job_stats_completed) &&
1411           (extra_stats & ex_stats_job_stats_background)) {
1412         ERROR(PLUGIN_NAME " plugin: Invalid job stats configuration. Only one "
1413                           "type of job statistics can be collected at the same "
1414                           "time");
1415         return -1;
1416       }
1417 #endif
1418
1419       /* ExtraStats parsed successfully */
1420       continue;
1421     } else if (strcasecmp(c->key, "PersistentNotification") == 0) {
1422       if (cf_util_get_boolean(c, &persistent_notification) != 0)
1423         return -1;
1424
1425       continue;
1426     } else if (strcasecmp(c->key, "ReportBlockDevices") == 0) {
1427       if (cf_util_get_boolean(c, &report_block_devices) != 0)
1428         return -1;
1429
1430       continue;
1431     } else if (strcasecmp(c->key, "ReportNetworkInterfaces") == 0) {
1432       if (cf_util_get_boolean(c, &report_network_interfaces) != 0)
1433         return -1;
1434
1435       continue;
1436     } else {
1437       /* Unrecognised option. */
1438       ERROR(PLUGIN_NAME " plugin: Unrecognized option: '%s'", c->key);
1439       return -1;
1440     }
1441   }
1442
1443   return 0;
1444 }
1445
1446 static int lv_connect(void) {
1447   if (conn == NULL) {
1448 /* `conn_string == NULL' is acceptable */
1449 #ifdef HAVE_FS_INFO
1450     /* virDomainGetFSInfo requires full read-write access connection */
1451     if (extra_stats & ex_stats_fs_info)
1452       conn = virConnectOpen(conn_string);
1453     else
1454 #endif
1455       conn = virConnectOpenReadOnly(conn_string);
1456     if (conn == NULL) {
1457       c_complain(LOG_ERR, &conn_complain,
1458                  PLUGIN_NAME " plugin: Unable to connect: "
1459                              "virConnectOpen failed.");
1460       return -1;
1461     }
1462     int status = virNodeGetInfo(conn, &nodeinfo);
1463     if (status != 0) {
1464       ERROR(PLUGIN_NAME " plugin: virNodeGetInfo failed");
1465       return -1;
1466     }
1467   }
1468   c_release(LOG_NOTICE, &conn_complain,
1469             PLUGIN_NAME " plugin: Connection established.");
1470   return 0;
1471 }
1472
1473 static void lv_disconnect(void) {
1474   if (conn != NULL)
1475     virConnectClose(conn);
1476   conn = NULL;
1477   WARNING(PLUGIN_NAME " plugin: closed connection to libvirt");
1478 }
1479
1480 static int lv_domain_block_stats(virDomainPtr dom, const char *path,
1481                                  struct lv_block_stats *bstats) {
1482 #ifdef HAVE_BLOCK_STATS_FLAGS
1483   int nparams = 0;
1484   if (virDomainBlockStatsFlags(dom, path, NULL, &nparams, 0) < 0 ||
1485       nparams <= 0) {
1486     VIRT_ERROR(conn, "getting the disk params count");
1487     return -1;
1488   }
1489
1490   virTypedParameterPtr params = calloc(nparams, sizeof(*params));
1491   if (params == NULL) {
1492     ERROR("virt plugin: alloc(%i) for block=%s parameters failed.", nparams,
1493           path);
1494     return -1;
1495   }
1496
1497   int rc = -1;
1498   if (virDomainBlockStatsFlags(dom, path, params, &nparams, 0) < 0) {
1499     VIRT_ERROR(conn, "getting the disk params values");
1500   } else {
1501     rc = get_block_stats(bstats, params, nparams);
1502   }
1503
1504   virTypedParamsClear(params, nparams);
1505   sfree(params);
1506   return rc;
1507 #else
1508   return virDomainBlockStats(dom, path, &(bstats->bi), sizeof(bstats->bi));
1509 #endif /* HAVE_BLOCK_STATS_FLAGS */
1510 }
1511
1512 #ifdef HAVE_PERF_STATS
1513 static void perf_submit(virDomainStatsRecordPtr stats) {
1514   for (int i = 0; i < stats->nparams; ++i) {
1515     /* Replace '.' with '_' in event field to match other metrics' naming
1516      * convention */
1517     char *c = strchr(stats->params[i].field, '.');
1518     if (c)
1519       *c = '_';
1520     submit(stats->dom, "perf", stats->params[i].field,
1521            &(value_t){.derive = stats->params[i].value.ul}, 1);
1522   }
1523 }
1524
1525 static int get_perf_events(virDomainPtr domain) {
1526   virDomainStatsRecordPtr *stats = NULL;
1527   /* virDomainListGetStats requires a NULL terminated list of domains */
1528   virDomainPtr domain_array[] = {domain, NULL};
1529
1530   int status =
1531       virDomainListGetStats(domain_array, VIR_DOMAIN_STATS_PERF, &stats, 0);
1532   if (status == -1) {
1533     ERROR("virt plugin: virDomainListGetStats failed with status %i.", status);
1534     return status;
1535   }
1536
1537   for (int i = 0; i < status; ++i)
1538     perf_submit(stats[i]);
1539
1540   virDomainStatsRecordListFree(stats);
1541   return 0;
1542 }
1543 #endif /* HAVE_PERF_STATS */
1544
1545 static void vcpu_pin_submit(virDomainPtr dom, int max_cpus, int vcpu,
1546                             unsigned char *cpu_maps, int cpu_map_len) {
1547   for (int cpu = 0; cpu < max_cpus; ++cpu) {
1548     char type_instance[DATA_MAX_NAME_LEN];
1549     bool is_set = VIR_CPU_USABLE(cpu_maps, cpu_map_len, vcpu, cpu);
1550
1551     snprintf(type_instance, sizeof(type_instance), "vcpu_%d-cpu_%d", vcpu, cpu);
1552     submit(dom, "cpu_affinity", type_instance, &(value_t){.gauge = is_set}, 1);
1553   }
1554 }
1555
1556 static int get_vcpu_stats(virDomainPtr domain, unsigned short nr_virt_cpu) {
1557   int max_cpus = VIR_NODEINFO_MAXCPUS(nodeinfo);
1558   int cpu_map_len = VIR_CPU_MAPLEN(max_cpus);
1559
1560   virVcpuInfoPtr vinfo = calloc(nr_virt_cpu, sizeof(*vinfo));
1561   if (vinfo == NULL) {
1562     ERROR(PLUGIN_NAME " plugin: calloc failed.");
1563     return -1;
1564   }
1565
1566   unsigned char *cpumaps = calloc(nr_virt_cpu, cpu_map_len);
1567   if (cpumaps == NULL) {
1568     ERROR(PLUGIN_NAME " plugin: calloc failed.");
1569     sfree(vinfo);
1570     return -1;
1571   }
1572
1573   int status =
1574       virDomainGetVcpus(domain, vinfo, nr_virt_cpu, cpumaps, cpu_map_len);
1575   if (status < 0) {
1576     ERROR(PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
1577           status);
1578     sfree(cpumaps);
1579     sfree(vinfo);
1580     return status;
1581   }
1582
1583   for (int i = 0; i < nr_virt_cpu; ++i) {
1584     vcpu_submit(vinfo[i].cpuTime, domain, vinfo[i].number, "virt_vcpu");
1585     if (extra_stats & ex_stats_vcpupin)
1586       vcpu_pin_submit(domain, max_cpus, i, cpumaps, cpu_map_len);
1587   }
1588
1589   sfree(cpumaps);
1590   sfree(vinfo);
1591   return 0;
1592 }
1593
1594 #ifdef HAVE_CPU_STATS
1595 static int get_pcpu_stats(virDomainPtr dom) {
1596   int nparams = virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0);
1597   if (nparams < 0) {
1598     VIRT_ERROR(conn, "getting the CPU params count");
1599     return -1;
1600   }
1601
1602   virTypedParameterPtr param = calloc(nparams, sizeof(*param));
1603   if (param == NULL) {
1604     ERROR(PLUGIN_NAME " plugin: alloc(%i) for cpu parameters failed.", nparams);
1605     return -1;
1606   }
1607
1608   int ret = virDomainGetCPUStats(dom, param, nparams, -1, 1, 0); // total stats.
1609   if (ret < 0) {
1610     virTypedParamsClear(param, nparams);
1611     sfree(param);
1612     VIRT_ERROR(conn, "getting the CPU params values");
1613     return -1;
1614   }
1615
1616   unsigned long long total_user_cpu_time = 0;
1617   unsigned long long total_syst_cpu_time = 0;
1618
1619   for (int i = 0; i < nparams; ++i) {
1620     if (!strcmp(param[i].field, "user_time"))
1621       total_user_cpu_time = param[i].value.ul;
1622     else if (!strcmp(param[i].field, "system_time"))
1623       total_syst_cpu_time = param[i].value.ul;
1624   }
1625
1626   if (total_user_cpu_time > 0 || total_syst_cpu_time > 0)
1627     submit_derive2("ps_cputime", total_user_cpu_time, total_syst_cpu_time, dom,
1628                    NULL);
1629
1630   virTypedParamsClear(param, nparams);
1631   sfree(param);
1632
1633   return 0;
1634 }
1635 #endif /* HAVE_CPU_STATS */
1636
1637 #ifdef HAVE_DOM_REASON
1638
1639 static void domain_state_submit(virDomainPtr dom, int state, int reason) {
1640   value_t values[] = {
1641       {.gauge = (gauge_t)state}, {.gauge = (gauge_t)reason},
1642   };
1643
1644   submit(dom, "domain_state", NULL, values, STATIC_ARRAY_SIZE(values));
1645 }
1646
1647 static int get_domain_state(virDomainPtr domain) {
1648   int domain_state = 0;
1649   int domain_reason = 0;
1650
1651   int status = virDomainGetState(domain, &domain_state, &domain_reason, 0);
1652   if (status != 0) {
1653     ERROR(PLUGIN_NAME " plugin: virDomainGetState failed with status %i.",
1654           status);
1655     return status;
1656   }
1657
1658   domain_state_submit(domain, domain_state, domain_reason);
1659
1660   return status;
1661 }
1662
1663 #ifdef HAVE_LIST_ALL_DOMAINS
1664 static int get_domain_state_notify(virDomainPtr domain) {
1665   int domain_state = 0;
1666   int domain_reason = 0;
1667
1668   int status = virDomainGetState(domain, &domain_state, &domain_reason, 0);
1669   if (status != 0) {
1670     ERROR(PLUGIN_NAME " plugin: virDomainGetState failed with status %i.",
1671           status);
1672     return status;
1673   }
1674
1675   if (persistent_notification)
1676     domain_state_submit_notif(domain, domain_state, domain_reason);
1677
1678   return status;
1679 }
1680 #endif /* HAVE_LIST_ALL_DOMAINS */
1681 #endif /* HAVE_DOM_REASON */
1682
1683 static int get_memory_stats(virDomainPtr domain) {
1684   virDomainMemoryStatPtr minfo =
1685       calloc(VIR_DOMAIN_MEMORY_STAT_NR, sizeof(*minfo));
1686   if (minfo == NULL) {
1687     ERROR("virt plugin: calloc failed.");
1688     return -1;
1689   }
1690
1691   int mem_stats =
1692       virDomainMemoryStats(domain, minfo, VIR_DOMAIN_MEMORY_STAT_NR, 0);
1693   if (mem_stats < 0) {
1694     ERROR("virt plugin: virDomainMemoryStats failed with mem_stats %i.",
1695           mem_stats);
1696     sfree(minfo);
1697     return mem_stats;
1698   }
1699
1700   for (int i = 0; i < mem_stats; i++)
1701     memory_stats_submit((gauge_t)minfo[i].val * 1024, domain, minfo[i].tag);
1702
1703   sfree(minfo);
1704   return 0;
1705 }
1706
1707 #ifdef HAVE_DISK_ERR
1708 static void disk_err_submit(virDomainPtr domain,
1709                             virDomainDiskErrorPtr disk_err) {
1710   submit(domain, "disk_error", disk_err->disk,
1711          &(value_t){.gauge = disk_err->error}, 1);
1712 }
1713
1714 static int get_disk_err(virDomainPtr domain) {
1715   /* Get preferred size of disk errors array */
1716   int disk_err_count = virDomainGetDiskErrors(domain, NULL, 0, 0);
1717   if (disk_err_count == -1) {
1718     ERROR(PLUGIN_NAME
1719           " plugin: failed to get preferred size of disk errors array");
1720     return -1;
1721   }
1722
1723   DEBUG(PLUGIN_NAME
1724         " plugin: preferred size of disk errors array: %d for domain %s",
1725         disk_err_count, virDomainGetName(domain));
1726   virDomainDiskError disk_err[disk_err_count];
1727
1728   disk_err_count = virDomainGetDiskErrors(domain, disk_err, disk_err_count, 0);
1729   if (disk_err_count == -1) {
1730     ERROR(PLUGIN_NAME " plugin: virDomainGetDiskErrors failed with status %d",
1731           disk_err_count);
1732     return -1;
1733   }
1734
1735   DEBUG(PLUGIN_NAME " plugin: detected %d disk errors in domain %s",
1736         disk_err_count, virDomainGetName(domain));
1737
1738   for (int i = 0; i < disk_err_count; ++i) {
1739     disk_err_submit(domain, &disk_err[i]);
1740     sfree(disk_err[i].disk);
1741   }
1742
1743   return 0;
1744 }
1745 #endif /* HAVE_DISK_ERR */
1746
1747 static int get_block_device_stats(struct block_device *block_dev) {
1748   if (!block_dev) {
1749     ERROR(PLUGIN_NAME " plugin: get_block_stats NULL pointer");
1750     return -1;
1751   }
1752
1753   virDomainBlockInfo binfo;
1754   init_block_info(&binfo);
1755
1756   /* Fetching block info stats only if needed*/
1757   if (extra_stats & (ex_stats_disk_allocation | ex_stats_disk_capacity |
1758                      ex_stats_disk_physical)) {
1759     /* Block info statistics can be only fetched from devices with 'source'
1760      * defined */
1761     if (block_dev->has_source) {
1762       if (virDomainGetBlockInfo(block_dev->dom, block_dev->path, &binfo, 0) <
1763           0) {
1764         ERROR(PLUGIN_NAME " plugin: virDomainGetBlockInfo failed for path: %s",
1765               block_dev->path);
1766         return -1;
1767       }
1768     }
1769   }
1770
1771   struct lv_block_stats bstats;
1772   init_block_stats(&bstats);
1773
1774   if (lv_domain_block_stats(block_dev->dom, block_dev->path, &bstats) < 0) {
1775     ERROR(PLUGIN_NAME " plugin: lv_domain_block_stats failed");
1776     return -1;
1777   }
1778
1779   disk_block_stats_submit(&bstats, block_dev->dom, block_dev->path, &binfo);
1780   return 0;
1781 }
1782
1783 #ifdef HAVE_FS_INFO
1784
1785 #define NM_ADD_ITEM(_fun, _name, _val)                                         \
1786   do {                                                                         \
1787     ret = _fun(&notif, _name, _val);                                           \
1788     if (ret != 0) {                                                            \
1789       ERROR(PLUGIN_NAME " plugin: failed to add notification metadata");       \
1790       goto cleanup;                                                            \
1791     }                                                                          \
1792   } while (0)
1793
1794 #define NM_ADD_STR_ITEMS(_items, _size)                                        \
1795   do {                                                                         \
1796     for (size_t _i = 0; _i < _size; ++_i) {                                    \
1797       DEBUG(PLUGIN_NAME                                                        \
1798             " plugin: Adding notification metadata name=%s value=%s",          \
1799             _items[_i].name, _items[_i].value);                                \
1800       NM_ADD_ITEM(plugin_notification_meta_add_string, _items[_i].name,        \
1801                   _items[_i].value);                                           \
1802     }                                                                          \
1803   } while (0)
1804
1805 static int fs_info_notify(virDomainPtr domain, virDomainFSInfoPtr fs_info) {
1806   notification_t notif;
1807   int ret = 0;
1808
1809   /* Local struct, just for the purpose of this function. */
1810   typedef struct nm_str_item_s {
1811     const char *name;
1812     const char *value;
1813   } nm_str_item_t;
1814
1815   nm_str_item_t fs_dev_alias[fs_info->ndevAlias];
1816   nm_str_item_t fs_str_items[] = {
1817       {.name = "mountpoint", .value = fs_info->mountpoint},
1818       {.name = "name", .value = fs_info->name},
1819       {.name = "fstype", .value = fs_info->fstype}};
1820
1821   for (size_t i = 0; i < fs_info->ndevAlias; ++i) {
1822     fs_dev_alias[i].name = "devAlias";
1823     fs_dev_alias[i].value = fs_info->devAlias[i];
1824   }
1825
1826   init_notif(&notif, domain, NOTIF_OKAY, "File system information",
1827              "file_system", NULL);
1828   NM_ADD_STR_ITEMS(fs_str_items, STATIC_ARRAY_SIZE(fs_str_items));
1829   NM_ADD_ITEM(plugin_notification_meta_add_unsigned_int, "ndevAlias",
1830               fs_info->ndevAlias);
1831   NM_ADD_STR_ITEMS(fs_dev_alias, fs_info->ndevAlias);
1832
1833   plugin_dispatch_notification(&notif);
1834
1835 cleanup:
1836   if (notif.meta)
1837     plugin_notification_meta_free(notif.meta);
1838   return ret;
1839 }
1840
1841 #undef RETURN_ON_ERR
1842 #undef NM_ADD_STR_ITEMS
1843
1844 static int get_fs_info(virDomainPtr domain) {
1845   virDomainFSInfoPtr *fs_info = NULL;
1846   int ret = 0;
1847
1848   int mount_points_cnt = virDomainGetFSInfo(domain, &fs_info, 0);
1849   if (mount_points_cnt == -1) {
1850     ERROR(PLUGIN_NAME " plugin: virDomainGetFSInfo failed: %d",
1851           mount_points_cnt);
1852     return mount_points_cnt;
1853   }
1854
1855   for (int i = 0; i < mount_points_cnt; ++i) {
1856     if (fs_info_notify(domain, fs_info[i]) != 0) {
1857       ERROR(PLUGIN_NAME " plugin: failed to send file system notification "
1858                         "for mount point %s",
1859             fs_info[i]->mountpoint);
1860       ret = -1;
1861     }
1862     virDomainFSInfoFree(fs_info[i]);
1863   }
1864
1865   sfree(fs_info);
1866   return ret;
1867 }
1868
1869 #endif /* HAVE_FS_INFO */
1870
1871 #ifdef HAVE_JOB_STATS
1872 static void job_stats_submit(virDomainPtr domain, virTypedParameterPtr param) {
1873   value_t vl = {0};
1874
1875   if (param->type == VIR_TYPED_PARAM_INT)
1876     vl.derive = param->value.i;
1877   else if (param->type == VIR_TYPED_PARAM_UINT)
1878     vl.derive = param->value.ui;
1879   else if (param->type == VIR_TYPED_PARAM_LLONG)
1880     vl.derive = param->value.l;
1881   else if (param->type == VIR_TYPED_PARAM_ULLONG)
1882     vl.derive = param->value.ul;
1883   else if (param->type == VIR_TYPED_PARAM_DOUBLE)
1884     vl.derive = param->value.d;
1885   else if (param->type == VIR_TYPED_PARAM_BOOLEAN)
1886     vl.derive = param->value.b;
1887   else if (param->type == VIR_TYPED_PARAM_STRING) {
1888     submit_notif(domain, NOTIF_OKAY, param->value.s, "job_stats", param->field);
1889     return;
1890   } else {
1891     ERROR(PLUGIN_NAME " plugin: unrecognized virTypedParameterType");
1892     return;
1893   }
1894
1895   submit(domain, "job_stats", param->field, &vl, 1);
1896 }
1897
1898 static int get_job_stats(virDomainPtr domain) {
1899   int ret = 0;
1900   int job_type = 0;
1901   int nparams = 0;
1902   virTypedParameterPtr params = NULL;
1903   int flags = (extra_stats & ex_stats_job_stats_completed)
1904                   ? VIR_DOMAIN_JOB_STATS_COMPLETED
1905                   : 0;
1906
1907   ret = virDomainGetJobStats(domain, &job_type, &params, &nparams, flags);
1908   if (ret != 0) {
1909     ERROR(PLUGIN_NAME " plugin: virDomainGetJobStats failed: %d", ret);
1910     return ret;
1911   }
1912
1913   DEBUG(PLUGIN_NAME " plugin: job_type=%d nparams=%d", job_type, nparams);
1914
1915   for (int i = 0; i < nparams; ++i) {
1916     DEBUG(PLUGIN_NAME " plugin: param[%d] field=%s type=%d", i, params[i].field,
1917           params[i].type);
1918     job_stats_submit(domain, &params[i]);
1919   }
1920
1921   virTypedParamsFree(params, nparams);
1922   return ret;
1923 }
1924 #endif /* HAVE_JOB_STATS */
1925
1926 static int get_domain_metrics(domain_t *domain) {
1927   if (!domain || !domain->ptr) {
1928     ERROR(PLUGIN_NAME " plugin: get_domain_metrics: NULL pointer");
1929     return -1;
1930   }
1931
1932   virDomainInfo info;
1933   int status = virDomainGetInfo(domain->ptr, &info);
1934   if (status != 0) {
1935     ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
1936           status);
1937     return -1;
1938   }
1939
1940   if (extra_stats & ex_stats_domain_state) {
1941 #ifdef HAVE_DOM_REASON
1942     /* At this point we already know domain's state from virDomainGetInfo call,
1943      * however it doesn't provide a reason for entering particular state.
1944      * We need to get it from virDomainGetState.
1945      */
1946     GET_STATS(get_domain_state, "domain reason", domain->ptr);
1947 #endif
1948   }
1949
1950   /* Gather remaining stats only for running domains */
1951   if (info.state != VIR_DOMAIN_RUNNING)
1952     return 0;
1953
1954 #ifdef HAVE_CPU_STATS
1955   if (extra_stats & ex_stats_pcpu)
1956     get_pcpu_stats(domain->ptr);
1957 #endif
1958
1959   cpu_submit(domain, info.cpuTime);
1960
1961   memory_submit(domain->ptr, (gauge_t)info.memory * 1024);
1962
1963   GET_STATS(get_vcpu_stats, "vcpu stats", domain->ptr, info.nrVirtCpu);
1964   GET_STATS(get_memory_stats, "memory stats", domain->ptr);
1965
1966 #ifdef HAVE_PERF_STATS
1967   if (extra_stats & ex_stats_perf)
1968     GET_STATS(get_perf_events, "performance monitoring events", domain->ptr);
1969 #endif
1970
1971 #ifdef HAVE_FS_INFO
1972   if (extra_stats & ex_stats_fs_info)
1973     GET_STATS(get_fs_info, "file system info", domain->ptr);
1974 #endif
1975
1976 #ifdef HAVE_DISK_ERR
1977   if (extra_stats & ex_stats_disk_err)
1978     GET_STATS(get_disk_err, "disk errors", domain->ptr);
1979 #endif
1980
1981 #ifdef HAVE_JOB_STATS
1982   if (extra_stats &
1983       (ex_stats_job_stats_completed | ex_stats_job_stats_background))
1984     GET_STATS(get_job_stats, "job stats", domain->ptr);
1985 #endif
1986
1987   /* Update cached virDomainInfo. It has to be done after cpu_submit */
1988   memcpy(&domain->info, &info, sizeof(domain->info));
1989
1990   return 0;
1991 }
1992
1993 static int get_if_dev_stats(struct interface_device *if_dev) {
1994   virDomainInterfaceStatsStruct stats = {0};
1995   char *display_name = NULL;
1996
1997   if (!if_dev) {
1998     ERROR(PLUGIN_NAME " plugin: get_if_dev_stats: NULL pointer");
1999     return -1;
2000   }
2001
2002   switch (interface_format) {
2003   case if_address:
2004     display_name = if_dev->address;
2005     break;
2006   case if_number:
2007     display_name = if_dev->number;
2008     break;
2009   case if_name:
2010   default:
2011     display_name = if_dev->path;
2012   }
2013
2014   if (virDomainInterfaceStats(if_dev->dom, if_dev->path, &stats,
2015                               sizeof(stats)) != 0) {
2016     ERROR(PLUGIN_NAME " plugin: virDomainInterfaceStats failed");
2017     return -1;
2018   }
2019
2020   if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
2021     submit_derive2("if_octets", (derive_t)stats.rx_bytes,
2022                    (derive_t)stats.tx_bytes, if_dev->dom, display_name);
2023
2024   if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
2025     submit_derive2("if_packets", (derive_t)stats.rx_packets,
2026                    (derive_t)stats.tx_packets, if_dev->dom, display_name);
2027
2028   if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
2029     submit_derive2("if_errors", (derive_t)stats.rx_errs,
2030                    (derive_t)stats.tx_errs, if_dev->dom, display_name);
2031
2032   if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
2033     submit_derive2("if_dropped", (derive_t)stats.rx_drop,
2034                    (derive_t)stats.tx_drop, if_dev->dom, display_name);
2035   return 0;
2036 }
2037
2038 static int domain_lifecycle_event_cb(__attribute__((unused)) virConnectPtr con_,
2039                                      virDomainPtr dom, int event, int detail,
2040                                      __attribute__((unused)) void *opaque) {
2041   int domain_state = map_domain_event_to_state(event);
2042   int domain_reason = 0; /* 0 means UNKNOWN reason for any state */
2043 #ifdef HAVE_DOM_REASON
2044   domain_reason = map_domain_event_detail_to_reason(event, detail);
2045 #endif
2046   domain_state_submit_notif(dom, domain_state, domain_reason);
2047
2048   return 0;
2049 }
2050
2051 static int register_event_impl(void) {
2052   if (virEventRegisterDefaultImpl() < 0) {
2053     virErrorPtr err = virGetLastError();
2054     ERROR(PLUGIN_NAME
2055           " plugin: error while event implementation registering: %s",
2056           err && err->message ? err->message : "Unknown error");
2057     return -1;
2058   }
2059
2060   return 0;
2061 }
2062
2063 static void virt_notif_thread_set_active(virt_notif_thread_t *thread_data,
2064                                          const bool active) {
2065   assert(thread_data != NULL);
2066   pthread_mutex_lock(&thread_data->active_mutex);
2067   thread_data->is_active = active;
2068   pthread_mutex_unlock(&thread_data->active_mutex);
2069 }
2070
2071 static bool virt_notif_thread_is_active(virt_notif_thread_t *thread_data) {
2072   bool active = false;
2073
2074   assert(thread_data != NULL);
2075   pthread_mutex_lock(&thread_data->active_mutex);
2076   active = thread_data->is_active;
2077   pthread_mutex_unlock(&thread_data->active_mutex);
2078
2079   return active;
2080 }
2081
2082 /* worker function running default event implementation */
2083 static void *event_loop_worker(void *arg) {
2084   virt_notif_thread_t *thread_data = (virt_notif_thread_t *)arg;
2085
2086   while (virt_notif_thread_is_active(thread_data)) {
2087     if (virEventRunDefaultImpl() < 0) {
2088       virErrorPtr err = virGetLastError();
2089       ERROR(PLUGIN_NAME " plugin: failed to run event loop: %s\n",
2090             err && err->message ? err->message : "Unknown error");
2091     }
2092   }
2093
2094   return NULL;
2095 }
2096
2097 static int virt_notif_thread_init(virt_notif_thread_t *thread_data) {
2098   int ret;
2099
2100   assert(thread_data != NULL);
2101   ret = pthread_mutex_init(&thread_data->active_mutex, NULL);
2102   if (ret != 0) {
2103     ERROR(PLUGIN_NAME " plugin: Failed to initialize mutex, err %u", ret);
2104     return ret;
2105   }
2106
2107   /**
2108    * '0' and positive integers are meaningful ID's, therefore setting
2109    * domain_event_cb_id to '-1'
2110    */
2111   thread_data->domain_event_cb_id = -1;
2112   pthread_mutex_lock(&thread_data->active_mutex);
2113   thread_data->is_active = false;
2114   pthread_mutex_unlock(&thread_data->active_mutex);
2115
2116   return 0;
2117 }
2118
2119 /* register domain event callback and start event loop thread */
2120 static int start_event_loop(virt_notif_thread_t *thread_data) {
2121   assert(thread_data != NULL);
2122   thread_data->domain_event_cb_id = virConnectDomainEventRegisterAny(
2123       conn, NULL, VIR_DOMAIN_EVENT_ID_LIFECYCLE,
2124       VIR_DOMAIN_EVENT_CALLBACK(domain_lifecycle_event_cb), NULL, NULL);
2125   if (thread_data->domain_event_cb_id == -1) {
2126     ERROR(PLUGIN_NAME " plugin: error while callback registering");
2127     return -1;
2128   }
2129
2130   DEBUG(PLUGIN_NAME " plugin: starting event loop");
2131
2132   virt_notif_thread_set_active(thread_data, 1);
2133   if (pthread_create(&thread_data->event_loop_tid, NULL, event_loop_worker,
2134                      thread_data)) {
2135     ERROR(PLUGIN_NAME " plugin: failed event loop thread creation");
2136     virt_notif_thread_set_active(thread_data, 0);
2137     virConnectDomainEventDeregisterAny(conn, thread_data->domain_event_cb_id);
2138     thread_data->domain_event_cb_id = -1;
2139     return -1;
2140   }
2141
2142   return 0;
2143 }
2144
2145 /* stop event loop thread and deregister callback */
2146 static void stop_event_loop(virt_notif_thread_t *thread_data) {
2147
2148   DEBUG(PLUGIN_NAME " plugin: stopping event loop");
2149
2150   /* Stopping loop */
2151   if (virt_notif_thread_is_active(thread_data)) {
2152     virt_notif_thread_set_active(thread_data, 0);
2153     if (pthread_join(notif_thread.event_loop_tid, NULL) != 0)
2154       ERROR(PLUGIN_NAME " plugin: stopping notification thread failed");
2155   }
2156
2157   /* ... and de-registering event handler */
2158   if (conn != NULL && thread_data->domain_event_cb_id != -1) {
2159     virConnectDomainEventDeregisterAny(conn, thread_data->domain_event_cb_id);
2160     thread_data->domain_event_cb_id = -1;
2161   }
2162 }
2163
2164 static int persistent_domains_state_notification(void) {
2165   int status = 0;
2166   int n;
2167 #ifdef HAVE_LIST_ALL_DOMAINS
2168   virDomainPtr *domains = NULL;
2169   n = virConnectListAllDomains(conn, &domains,
2170                                VIR_CONNECT_LIST_DOMAINS_PERSISTENT);
2171   if (n < 0) {
2172     VIRT_ERROR(conn, "reading list of persistent domains");
2173     status = -1;
2174   } else {
2175     DEBUG(PLUGIN_NAME " plugin: getting state of %i persistent domains", n);
2176     /* Fetch each persistent domain's state and notify it */
2177     int n_notified = n;
2178     for (int i = 0; i < n; ++i) {
2179       status = get_domain_state_notify(domains[i]);
2180       if (status != 0) {
2181         n_notified--;
2182         ERROR(PLUGIN_NAME " plugin: could not notify state of domain %s",
2183               virDomainGetName(domains[i]));
2184       }
2185       virDomainFree(domains[i]);
2186     }
2187
2188     sfree(domains);
2189     DEBUG(PLUGIN_NAME " plugin: notified state of %i persistent domains",
2190           n_notified);
2191   }
2192 #else
2193   n = virConnectNumOfDomains(conn);
2194   if (n > 0) {
2195     int *domids;
2196     /* Get list of domains. */
2197     domids = calloc(n, sizeof(*domids));
2198     if (domids == NULL) {
2199       ERROR(PLUGIN_NAME " plugin: calloc failed.");
2200       return -1;
2201     }
2202     n = virConnectListDomains(conn, domids, n);
2203     if (n < 0) {
2204       VIRT_ERROR(conn, "reading list of domains");
2205       sfree(domids);
2206       return -1;
2207     }
2208     /* Fetch info of each active domain and notify it */
2209     for (int i = 0; i < n; ++i) {
2210       virDomainInfo info;
2211       virDomainPtr dom = NULL;
2212       dom = virDomainLookupByID(conn, domids[i]);
2213       if (dom == NULL) {
2214         VIRT_ERROR(conn, "virDomainLookupByID");
2215         /* Could be that the domain went away -- ignore it anyway. */
2216         continue;
2217       }
2218       status = virDomainGetInfo(dom, &info);
2219       if (status == 0)
2220         /* virDomainGetState is not available. Submit 0, which corresponds to
2221          * unknown reason. */
2222         domain_state_submit_notif(dom, info.state, 0);
2223       else
2224         ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
2225               status);
2226
2227       virDomainFree(dom);
2228     }
2229     sfree(domids);
2230   }
2231 #endif
2232
2233   return status;
2234 }
2235
2236 static int lv_read(user_data_t *ud) {
2237   time_t t;
2238   struct lv_read_instance *inst = NULL;
2239   struct lv_read_state *state = NULL;
2240
2241   if (ud->data == NULL) {
2242     ERROR(PLUGIN_NAME " plugin: NULL userdata");
2243     return -1;
2244   }
2245
2246   inst = ud->data;
2247   state = &inst->read_state;
2248
2249   bool reconnect = conn == NULL ? true : false;
2250   /* event implementation must be registered before connection is opened */
2251   if (inst->id == 0) {
2252     if (!persistent_notification && reconnect)
2253       if (register_event_impl() != 0)
2254         return -1;
2255
2256     if (lv_connect() < 0)
2257       return -1;
2258
2259     if (!persistent_notification && reconnect && conn != NULL)
2260       if (start_event_loop(&notif_thread) != 0)
2261         return -1;
2262   }
2263
2264   time(&t);
2265
2266   /* Need to refresh domain or device lists? */
2267   if ((last_refresh == (time_t)0) ||
2268       ((interval > 0) && ((last_refresh + interval) <= t))) {
2269     if (refresh_lists(inst) != 0) {
2270       if (inst->id == 0) {
2271         if (!persistent_notification)
2272           stop_event_loop(&notif_thread);
2273         lv_disconnect();
2274       }
2275       return -1;
2276     }
2277     last_refresh = t;
2278   }
2279
2280   /* persistent domains state notifications are handled by instance 0 */
2281   if (inst->id == 0 && persistent_notification) {
2282     int status = persistent_domains_state_notification();
2283     if (status != 0)
2284       DEBUG(PLUGIN_NAME " plugin: persistent_domains_state_notifications "
2285                         "returned with status %i",
2286             status);
2287   }
2288
2289 #if COLLECT_DEBUG
2290   for (int i = 0; i < state->nr_domains; ++i)
2291     DEBUG(PLUGIN_NAME " plugin: domain %s",
2292           virDomainGetName(state->domains[i].ptr));
2293   for (int i = 0; i < state->nr_block_devices; ++i)
2294     DEBUG(PLUGIN_NAME " plugin: block device %d %s:%s", i,
2295           virDomainGetName(state->block_devices[i].dom),
2296           state->block_devices[i].path);
2297   for (int i = 0; i < state->nr_interface_devices; ++i)
2298     DEBUG(PLUGIN_NAME " plugin: interface device %d %s:%s", i,
2299           virDomainGetName(state->interface_devices[i].dom),
2300           state->interface_devices[i].path);
2301 #endif
2302
2303   /* Get domains' metrics */
2304   for (int i = 0; i < state->nr_domains; ++i) {
2305     domain_t *dom = &state->domains[i];
2306     int status = 0;
2307     if (dom->active)
2308       status = get_domain_metrics(dom);
2309 #ifdef HAVE_DOM_REASON
2310     else
2311       status = get_domain_state(dom->ptr);
2312 #endif
2313
2314     if (status != 0)
2315       ERROR(PLUGIN_NAME " plugin: failed to get metrics for domain=%s",
2316             virDomainGetName(dom->ptr));
2317   }
2318
2319   /* Get block device stats for each domain. */
2320   for (int i = 0; i < state->nr_block_devices; ++i) {
2321     int status = get_block_device_stats(&state->block_devices[i]);
2322     if (status != 0)
2323       ERROR(PLUGIN_NAME
2324             " plugin: failed to get stats for block device (%s) in domain %s",
2325             state->block_devices[i].path,
2326             virDomainGetName(state->block_devices[i].dom));
2327   }
2328
2329   /* Get interface stats for each domain. */
2330   for (int i = 0; i < state->nr_interface_devices; ++i) {
2331     int status = get_if_dev_stats(&state->interface_devices[i]);
2332     if (status != 0)
2333       ERROR(
2334           PLUGIN_NAME
2335           " plugin: failed to get interface stats for device (%s) in domain %s",
2336           state->interface_devices[i].path,
2337           virDomainGetName(state->interface_devices[i].dom));
2338   }
2339
2340   return 0;
2341 }
2342
2343 static int lv_init_instance(size_t i, plugin_read_cb callback) {
2344   struct lv_user_data *lv_ud = &(lv_read_user_data[i]);
2345   struct lv_read_instance *inst = &(lv_ud->inst);
2346
2347   memset(lv_ud, 0, sizeof(*lv_ud));
2348
2349   snprintf(inst->tag, sizeof(inst->tag), "%s-%" PRIsz, PLUGIN_NAME, i);
2350   inst->id = i;
2351
2352   user_data_t *ud = &(lv_ud->ud);
2353   ud->data = inst;
2354   ud->free_func = NULL;
2355
2356   INFO(PLUGIN_NAME " plugin: reader %s initialized", inst->tag);
2357
2358   return plugin_register_complex_read(NULL, inst->tag, callback, 0, ud);
2359 }
2360
2361 static void lv_clean_read_state(struct lv_read_state *state) {
2362   free_block_devices(state);
2363   free_interface_devices(state);
2364   free_domains(state);
2365 }
2366
2367 static void lv_fini_instance(size_t i) {
2368   struct lv_read_instance *inst = &(lv_read_user_data[i].inst);
2369   struct lv_read_state *state = &(inst->read_state);
2370
2371   lv_clean_read_state(state);
2372
2373   INFO(PLUGIN_NAME " plugin: reader %s finalized", inst->tag);
2374 }
2375
2376 static int lv_init(void) {
2377   if (virInitialize() != 0)
2378     return -1;
2379
2380   /* Init ignorelists if there was no explicit configuration */
2381   if (lv_init_ignorelists() != 0)
2382     return -1;
2383
2384   /* event implementation must be registered before connection is opened */
2385   if (!persistent_notification)
2386     if (register_event_impl() != 0)
2387       return -1;
2388
2389   if (lv_connect() != 0)
2390     return -1;
2391
2392   if (!persistent_notification) {
2393     virt_notif_thread_init(&notif_thread);
2394     if (start_event_loop(&notif_thread) != 0)
2395       return -1;
2396   }
2397
2398   DEBUG(PLUGIN_NAME " plugin: starting %i instances", nr_instances);
2399
2400   for (int i = 0; i < nr_instances; ++i)
2401     if (lv_init_instance(i, lv_read) != 0)
2402       return -1;
2403
2404   return 0;
2405 }
2406
2407 /*
2408  * returns 0 on success and <0 on error
2409  */
2410 static int lv_domain_get_tag(xmlXPathContextPtr xpath_ctx, const char *dom_name,
2411                              char *dom_tag) {
2412   char xpath_str[BUFFER_MAX_LEN] = {'\0'};
2413   xmlXPathObjectPtr xpath_obj = NULL;
2414   xmlNodePtr xml_node = NULL;
2415   int ret = -1;
2416   int err;
2417
2418   err = xmlXPathRegisterNs(xpath_ctx,
2419                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX,
2420                            (const xmlChar *)METADATA_VM_PARTITION_URI);
2421   if (err) {
2422     ERROR(PLUGIN_NAME " plugin: xmlXpathRegisterNs(%s, %s) failed on domain %s",
2423           METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_URI, dom_name);
2424     goto done;
2425   }
2426
2427   snprintf(xpath_str, sizeof(xpath_str), "/domain/metadata/%s:%s/text()",
2428            METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_ELEMENT);
2429   xpath_obj = xmlXPathEvalExpression((xmlChar *)xpath_str, xpath_ctx);
2430   if (xpath_obj == NULL) {
2431     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed on domain %s",
2432           xpath_str, dom_name);
2433     goto done;
2434   }
2435
2436   if (xpath_obj->type != XPATH_NODESET) {
2437     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
2438                       "(wanted %d) on domain %s",
2439           xpath_str, xpath_obj->type, XPATH_NODESET, dom_name);
2440     goto done;
2441   }
2442
2443   /*
2444    * from now on there is no real error, it's ok if a domain
2445    * doesn't have the metadata partition tag.
2446    */
2447   ret = 0;
2448   if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
2449     DEBUG(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
2450                       "expected=1 on domain %s",
2451           xpath_str,
2452           (xpath_obj->nodesetval == NULL) ? 0 : xpath_obj->nodesetval->nodeNr,
2453           dom_name);
2454   } else {
2455     xml_node = xpath_obj->nodesetval->nodeTab[0];
2456     sstrncpy(dom_tag, (const char *)xml_node->content, PARTITION_TAG_MAX_LEN);
2457   }
2458
2459 done:
2460   /* deregister to clean up */
2461   err = xmlXPathRegisterNs(xpath_ctx,
2462                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX, NULL);
2463   if (err) {
2464     /* we can't really recover here */
2465     ERROR(PLUGIN_NAME
2466           " plugin: deregistration of namespace %s failed for domain %s",
2467           METADATA_VM_PARTITION_PREFIX, dom_name);
2468   }
2469   if (xpath_obj)
2470     xmlXPathFreeObject(xpath_obj);
2471
2472   return ret;
2473 }
2474
2475 static int is_known_tag(const char *dom_tag) {
2476   for (int i = 0; i < nr_instances; ++i)
2477     if (!strcmp(dom_tag, lv_read_user_data[i].inst.tag))
2478       return 1;
2479   return 0;
2480 }
2481
2482 static int lv_instance_include_domain(struct lv_read_instance *inst,
2483                                       const char *dom_name,
2484                                       const char *dom_tag) {
2485   if ((dom_tag[0] != '\0') && (strcmp(dom_tag, inst->tag) == 0))
2486     return 1;
2487
2488   /* instance#0 will always be there, so it is in charge of extra duties */
2489   if (inst->id == 0) {
2490     if (dom_tag[0] == '\0' || !is_known_tag(dom_tag)) {
2491       DEBUG(PLUGIN_NAME " plugin#%s: refreshing domain %s "
2492                         "with unknown tag '%s'",
2493             inst->tag, dom_name, dom_tag);
2494       return 1;
2495     }
2496   }
2497
2498   return 0;
2499 }
2500
2501 static void lv_add_block_devices(struct lv_read_state *state, virDomainPtr dom,
2502                                  const char *domname,
2503                                  xmlXPathContextPtr xpath_ctx) {
2504   xmlXPathObjectPtr xpath_obj =
2505       xmlXPathEval((const xmlChar *)"/domain/devices/disk", xpath_ctx);
2506
2507   if (xpath_obj == NULL) {
2508     DEBUG(PLUGIN_NAME " plugin: no disk xpath-object found for domain %s",
2509           domname);
2510     return;
2511   }
2512
2513   if (xpath_obj->type != XPATH_NODESET || xpath_obj->nodesetval == NULL) {
2514     DEBUG(PLUGIN_NAME " plugin: no disk node found for domain %s", domname);
2515     goto cleanup;
2516   }
2517
2518   xmlNodeSetPtr xml_block_devices = xpath_obj->nodesetval;
2519   for (int i = 0; i < xml_block_devices->nodeNr; ++i) {
2520     xmlNodePtr xml_device = xpath_obj->nodesetval->nodeTab[i];
2521     char *path_str = NULL;
2522     char *source_str = NULL;
2523
2524     if (!xml_device)
2525       continue;
2526
2527     /* Fetching path and source for block device */
2528     for (xmlNodePtr child = xml_device->children; child; child = child->next) {
2529       if (child->type != XML_ELEMENT_NODE)
2530         continue;
2531
2532       /* we are interested only in either "target" or "source" elements */
2533       if (xmlStrEqual(child->name, (const xmlChar *)"target"))
2534         path_str = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2535       else if (xmlStrEqual(child->name, (const xmlChar *)"source")) {
2536         /* name of the source is located in "dev" or "file" element (it depends
2537          * on type of source). Trying "dev" at first*/
2538         source_str = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2539         if (!source_str)
2540           source_str = (char *)xmlGetProp(child, (const xmlChar *)"file");
2541       }
2542       /* ignoring any other element*/
2543     }
2544
2545     /* source_str will be interpreted as a device path if blockdevice_format
2546      *  param is set to 'source'. */
2547     const char *device_path =
2548         (blockdevice_format == source) ? source_str : path_str;
2549
2550     if (!device_path) {
2551       /* no path found and we can't add block_device without it */
2552       WARNING(PLUGIN_NAME " plugin: could not generate device path for disk in "
2553                           "domain %s - disk device will be ignored in reports",
2554               domname);
2555       goto cont;
2556     }
2557
2558     if (ignore_device_match(il_block_devices, domname, device_path) == 0) {
2559       /* we only have to store information whether 'source' exists or not */
2560       bool has_source = (source_str != NULL) ? true : false;
2561
2562       add_block_device(state, dom, device_path, has_source);
2563     }
2564
2565   cont:
2566     if (path_str)
2567       xmlFree(path_str);
2568
2569     if (source_str)
2570       xmlFree(source_str);
2571   }
2572
2573 cleanup:
2574   xmlXPathFreeObject(xpath_obj);
2575 }
2576
2577 static void lv_add_network_interfaces(struct lv_read_state *state,
2578                                       virDomainPtr dom, const char *domname,
2579                                       xmlXPathContextPtr xpath_ctx) {
2580   xmlXPathObjectPtr xpath_obj = xmlXPathEval(
2581       (xmlChar *)"/domain/devices/interface[target[@dev]]", xpath_ctx);
2582
2583   if (xpath_obj == NULL)
2584     return;
2585
2586   if (xpath_obj->type != XPATH_NODESET || xpath_obj->nodesetval == NULL) {
2587     xmlXPathFreeObject(xpath_obj);
2588     return;
2589   }
2590
2591   xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
2592
2593   for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
2594     char *path = NULL;
2595     char *address = NULL;
2596     const int itf_number = j + 1;
2597
2598     xmlNodePtr xml_interface = xml_interfaces->nodeTab[j];
2599     if (!xml_interface)
2600       continue;
2601
2602     for (xmlNodePtr child = xml_interface->children; child;
2603          child = child->next) {
2604       if (child->type != XML_ELEMENT_NODE)
2605         continue;
2606
2607       if (xmlStrEqual(child->name, (const xmlChar *)"target")) {
2608         path = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2609         if (!path)
2610           continue;
2611       } else if (xmlStrEqual(child->name, (const xmlChar *)"mac")) {
2612         address = (char *)xmlGetProp(child, (const xmlChar *)"address");
2613         if (!address)
2614           continue;
2615       }
2616     }
2617
2618     bool device_ignored = false;
2619     switch (interface_format) {
2620     case if_name:
2621       if (ignore_device_match(il_interface_devices, domname, path) != 0)
2622         device_ignored = true;
2623       break;
2624     case if_address:
2625       if (ignore_device_match(il_interface_devices, domname, address) != 0)
2626         device_ignored = true;
2627       break;
2628     case if_number: {
2629       char number_string[4];
2630       snprintf(number_string, sizeof(number_string), "%d", itf_number);
2631       if (ignore_device_match(il_interface_devices, domname, number_string) !=
2632           0)
2633         device_ignored = true;
2634     } break;
2635     default:
2636       ERROR(PLUGIN_NAME " plugin: Unknown interface_format option: %d",
2637             interface_format);
2638     }
2639
2640     if (!device_ignored)
2641       add_interface_device(state, dom, path, address, itf_number);
2642
2643     if (path)
2644       xmlFree(path);
2645     if (address)
2646       xmlFree(address);
2647   }
2648   xmlXPathFreeObject(xpath_obj);
2649 }
2650
2651 static bool is_domain_ignored(virDomainPtr dom) {
2652   const char *domname = virDomainGetName(dom);
2653
2654   if (domname == NULL) {
2655     VIRT_ERROR(conn, "virDomainGetName failed, ignoring domain");
2656     return true;
2657   }
2658
2659   if (ignorelist_match(il_domains, domname) != 0) {
2660     DEBUG(PLUGIN_NAME
2661           " plugin: ignoring domain '%s' because of ignorelist option",
2662           domname);
2663     return true;
2664   }
2665
2666   return false;
2667 }
2668
2669 static int refresh_lists(struct lv_read_instance *inst) {
2670   struct lv_read_state *state = &inst->read_state;
2671   int n;
2672
2673 #ifndef HAVE_LIST_ALL_DOMAINS
2674   n = virConnectNumOfDomains(conn);
2675   if (n < 0) {
2676     VIRT_ERROR(conn, "reading number of domains");
2677     return -1;
2678   }
2679 #endif
2680
2681   lv_clean_read_state(state);
2682
2683 #ifndef HAVE_LIST_ALL_DOMAINS
2684   if (n == 0)
2685     goto end;
2686 #endif
2687
2688 #ifdef HAVE_LIST_ALL_DOMAINS
2689   virDomainPtr *domains, *domains_inactive;
2690   int m = virConnectListAllDomains(conn, &domains_inactive,
2691                                    VIR_CONNECT_LIST_DOMAINS_INACTIVE);
2692   n = virConnectListAllDomains(conn, &domains, VIR_CONNECT_LIST_DOMAINS_ACTIVE);
2693 #else
2694   /* Get list of domains. */
2695   int *domids = calloc(n, sizeof(*domids));
2696   if (domids == NULL) {
2697     ERROR(PLUGIN_NAME " plugin: calloc failed.");
2698     return -1;
2699   }
2700
2701   n = virConnectListDomains(conn, domids, n);
2702 #endif
2703
2704   if (n < 0) {
2705     VIRT_ERROR(conn, "reading list of domains");
2706 #ifndef HAVE_LIST_ALL_DOMAINS
2707     sfree(domids);
2708 #else
2709     for (int i = 0; i < m; ++i)
2710       virDomainFree(domains_inactive[i]);
2711     sfree(domains_inactive);
2712 #endif
2713     return -1;
2714   }
2715
2716 #ifdef HAVE_LIST_ALL_DOMAINS
2717   for (int i = 0; i < m; ++i)
2718     if (is_domain_ignored(domains_inactive[i]) ||
2719         add_domain(state, domains_inactive[i], 0) < 0) {
2720       /* domain ignored or failed during adding to domains list*/
2721       virDomainFree(domains_inactive[i]);
2722       domains_inactive[i] = NULL;
2723       continue;
2724     }
2725 #endif
2726
2727   /* Fetch each domain and add it to the list, unless ignore. */
2728   for (int i = 0; i < n; ++i) {
2729
2730 #ifdef HAVE_LIST_ALL_DOMAINS
2731     virDomainPtr dom = domains[i];
2732 #else
2733     virDomainPtr dom = virDomainLookupByID(conn, domids[i]);
2734     if (dom == NULL) {
2735       VIRT_ERROR(conn, "virDomainLookupByID");
2736       /* Could be that the domain went away -- ignore it anyway. */
2737       continue;
2738     }
2739 #endif
2740
2741     if (is_domain_ignored(dom) || add_domain(state, dom, 1) < 0) {
2742       /*
2743        * domain ignored or failed during adding to domains list
2744        *
2745        * When domain is already tracked, then there is
2746        * no problem with memory handling (will be freed
2747        * with the rest of domains cached data)
2748        * But in case of error like this (error occurred
2749        * before adding domain to track) we have to take
2750        * care it ourselves and call virDomainFree
2751        */
2752       virDomainFree(dom);
2753       continue;
2754     }
2755
2756     const char *domname = virDomainGetName(dom);
2757     if (domname == NULL) {
2758       VIRT_ERROR(conn, "virDomainGetName");
2759       continue;
2760     }
2761
2762     virDomainInfo info;
2763     int status = virDomainGetInfo(dom, &info);
2764     if (status != 0) {
2765       ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
2766             status);
2767       continue;
2768     }
2769
2770     if (info.state != VIR_DOMAIN_RUNNING) {
2771       DEBUG(PLUGIN_NAME " plugin: skipping inactive domain %s", domname);
2772       continue;
2773     }
2774
2775     /* Get a list of devices for this domain. */
2776     xmlDocPtr xml_doc = NULL;
2777     xmlXPathContextPtr xpath_ctx = NULL;
2778
2779     char *xml = virDomainGetXMLDesc(dom, 0);
2780     if (!xml) {
2781       VIRT_ERROR(conn, "virDomainGetXMLDesc");
2782       goto cont;
2783     }
2784
2785     /* Yuck, XML.  Parse out the devices. */
2786     xml_doc = xmlReadDoc((xmlChar *)xml, NULL, NULL, XML_PARSE_NONET);
2787     if (xml_doc == NULL) {
2788       VIRT_ERROR(conn, "xmlReadDoc");
2789       goto cont;
2790     }
2791
2792     xpath_ctx = xmlXPathNewContext(xml_doc);
2793
2794     char tag[PARTITION_TAG_MAX_LEN] = {'\0'};
2795     if (lv_domain_get_tag(xpath_ctx, domname, tag) < 0) {
2796       ERROR(PLUGIN_NAME " plugin: lv_domain_get_tag failed.");
2797       goto cont;
2798     }
2799
2800     if (!lv_instance_include_domain(inst, domname, tag))
2801       goto cont;
2802
2803     /* Block devices. */
2804     if (report_block_devices)
2805       lv_add_block_devices(state, dom, domname, xpath_ctx);
2806
2807     /* Network interfaces. */
2808     if (report_network_interfaces)
2809       lv_add_network_interfaces(state, dom, domname, xpath_ctx);
2810
2811   cont:
2812     if (xpath_ctx)
2813       xmlXPathFreeContext(xpath_ctx);
2814     if (xml_doc)
2815       xmlFreeDoc(xml_doc);
2816     sfree(xml);
2817   }
2818
2819 #ifdef HAVE_LIST_ALL_DOMAINS
2820   /* NOTE: domains_active and domains_inactive data will be cleared during
2821      refresh of all domains (inside lv_clean_read_state function) so we need
2822      to free here only allocated arrays */
2823   sfree(domains);
2824   sfree(domains_inactive);
2825 #else
2826   sfree(domids);
2827
2828 end:
2829 #endif
2830
2831   DEBUG(PLUGIN_NAME " plugin#%s: refreshing"
2832                     " domains=%i block_devices=%i iface_devices=%i",
2833         inst->tag, state->nr_domains, state->nr_block_devices,
2834         state->nr_interface_devices);
2835
2836   return 0;
2837 }
2838
2839 static void free_domains(struct lv_read_state *state) {
2840   if (state->domains) {
2841     for (int i = 0; i < state->nr_domains; ++i)
2842       virDomainFree(state->domains[i].ptr);
2843     sfree(state->domains);
2844   }
2845   state->domains = NULL;
2846   state->nr_domains = 0;
2847 }
2848
2849 static int add_domain(struct lv_read_state *state, virDomainPtr dom,
2850                       bool active) {
2851   int new_size = sizeof(state->domains[0]) * (state->nr_domains + 1);
2852
2853   domain_t *new_ptr = realloc(state->domains, new_size);
2854   if (new_ptr == NULL) {
2855     ERROR(PLUGIN_NAME " plugin: realloc failed in add_domain()");
2856     return -1;
2857   }
2858
2859   state->domains = new_ptr;
2860   state->domains[state->nr_domains].ptr = dom;
2861   state->domains[state->nr_domains].active = active;
2862   memset(&state->domains[state->nr_domains].info, 0,
2863          sizeof(state->domains[state->nr_domains].info));
2864
2865   return state->nr_domains++;
2866 }
2867
2868 static void free_block_devices(struct lv_read_state *state) {
2869   if (state->block_devices) {
2870     for (int i = 0; i < state->nr_block_devices; ++i)
2871       sfree(state->block_devices[i].path);
2872     sfree(state->block_devices);
2873   }
2874   state->block_devices = NULL;
2875   state->nr_block_devices = 0;
2876 }
2877
2878 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
2879                             const char *path, bool has_source) {
2880
2881   char *path_copy = strdup(path);
2882   if (!path_copy)
2883     return -1;
2884
2885   int new_size =
2886       sizeof(state->block_devices[0]) * (state->nr_block_devices + 1);
2887
2888   struct block_device *new_ptr = realloc(state->block_devices, new_size);
2889   if (new_ptr == NULL) {
2890     sfree(path_copy);
2891     return -1;
2892   }
2893   state->block_devices = new_ptr;
2894   state->block_devices[state->nr_block_devices].dom = dom;
2895   state->block_devices[state->nr_block_devices].path = path_copy;
2896   state->block_devices[state->nr_block_devices].has_source = has_source;
2897   return state->nr_block_devices++;
2898 }
2899
2900 static void free_interface_devices(struct lv_read_state *state) {
2901   if (state->interface_devices) {
2902     for (int i = 0; i < state->nr_interface_devices; ++i) {
2903       sfree(state->interface_devices[i].path);
2904       sfree(state->interface_devices[i].address);
2905       sfree(state->interface_devices[i].number);
2906     }
2907     sfree(state->interface_devices);
2908   }
2909   state->interface_devices = NULL;
2910   state->nr_interface_devices = 0;
2911 }
2912
2913 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
2914                                 const char *path, const char *address,
2915                                 unsigned int number) {
2916
2917   if ((path == NULL) || (address == NULL))
2918     return EINVAL;
2919
2920   char *path_copy = strdup(path);
2921   if (!path_copy)
2922     return -1;
2923
2924   char *address_copy = strdup(address);
2925   if (!address_copy) {
2926     sfree(path_copy);
2927     return -1;
2928   }
2929
2930   char number_string[21];
2931   snprintf(number_string, sizeof(number_string), "interface-%u", number);
2932   char *number_copy = strdup(number_string);
2933   if (!number_copy) {
2934     sfree(path_copy);
2935     sfree(address_copy);
2936     return -1;
2937   }
2938
2939   int new_size =
2940       sizeof(state->interface_devices[0]) * (state->nr_interface_devices + 1);
2941
2942   struct interface_device *new_ptr =
2943       realloc(state->interface_devices, new_size);
2944   if (new_ptr == NULL) {
2945     sfree(path_copy);
2946     sfree(address_copy);
2947     sfree(number_copy);
2948     return -1;
2949   }
2950
2951   state->interface_devices = new_ptr;
2952   state->interface_devices[state->nr_interface_devices].dom = dom;
2953   state->interface_devices[state->nr_interface_devices].path = path_copy;
2954   state->interface_devices[state->nr_interface_devices].address = address_copy;
2955   state->interface_devices[state->nr_interface_devices].number = number_copy;
2956   return state->nr_interface_devices++;
2957 }
2958
2959 static int ignore_device_match(ignorelist_t *il, const char *domname,
2960                                const char *devpath) {
2961   if ((domname == NULL) || (devpath == NULL))
2962     return 0;
2963
2964   size_t n = strlen(domname) + strlen(devpath) + 2;
2965   char *name = malloc(n);
2966   if (name == NULL) {
2967     ERROR(PLUGIN_NAME " plugin: malloc failed.");
2968     return 0;
2969   }
2970   snprintf(name, n, "%s:%s", domname, devpath);
2971   int r = ignorelist_match(il, name);
2972   sfree(name);
2973   return r;
2974 }
2975
2976 static int lv_shutdown(void) {
2977   for (int i = 0; i < nr_instances; ++i) {
2978     lv_fini_instance(i);
2979   }
2980
2981   if (!persistent_notification)
2982     stop_event_loop(&notif_thread);
2983
2984   lv_disconnect();
2985
2986   ignorelist_free(il_domains);
2987   il_domains = NULL;
2988   ignorelist_free(il_block_devices);
2989   il_block_devices = NULL;
2990   ignorelist_free(il_interface_devices);
2991   il_interface_devices = NULL;
2992
2993   return 0;
2994 }
2995
2996 void module_register(void) {
2997   plugin_register_complex_config("virt", lv_config);
2998   plugin_register_init(PLUGIN_NAME, lv_init);
2999   plugin_register_shutdown(PLUGIN_NAME, lv_shutdown);
3000 }