virt: Add NULL checking to multiple config strings validation
[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   submit(dom, "memory", tags[tag_index], &(value_t){.gauge = value}, 1);
930 }
931
932 static void submit_derive2(const char *type, derive_t v0, derive_t v1,
933                            virDomainPtr dom, const char *devname) {
934   value_t values[] = {
935       {.derive = v0}, {.derive = v1},
936   };
937
938   submit(dom, type, devname, values, STATIC_ARRAY_SIZE(values));
939 } /* void submit_derive2 */
940
941 static double cpu_ns_to_percent(unsigned int node_cpus,
942                                 unsigned long long cpu_time_old,
943                                 unsigned long long cpu_time_new) {
944   double percent = 0.0;
945   unsigned long long cpu_time_diff = 0;
946   double time_diff_sec = CDTIME_T_TO_DOUBLE(plugin_get_interval());
947
948   if (node_cpus != 0 && time_diff_sec != 0 && cpu_time_old != 0) {
949     cpu_time_diff = cpu_time_new - cpu_time_old;
950     percent = ((double)(100 * cpu_time_diff)) /
951               (time_diff_sec * node_cpus * NANOSEC_IN_SEC);
952   }
953
954   DEBUG(PLUGIN_NAME " plugin: node_cpus=%u cpu_time_old=%" PRIu64
955                     " cpu_time_new=%" PRIu64 "cpu_time_diff=%" PRIu64
956                     " time_diff_sec=%f percent=%f",
957         node_cpus, (uint64_t)cpu_time_old, (uint64_t)cpu_time_new,
958         (uint64_t)cpu_time_diff, time_diff_sec, percent);
959
960   return percent;
961 }
962
963 static void cpu_submit(const domain_t *dom, unsigned long long cpuTime_new) {
964
965   if (!dom)
966     return;
967
968   if (extra_stats & ex_stats_cpu_util) {
969     /* Computing %CPU requires 2 samples of cpuTime */
970     if (dom->info.cpuTime != 0 && cpuTime_new != 0) {
971
972       submit(dom->ptr, "percent", "virt_cpu_total",
973              &(value_t){.gauge = cpu_ns_to_percent(
974                             nodeinfo.cpus, dom->info.cpuTime, cpuTime_new)},
975              1);
976     }
977   }
978
979   submit(dom->ptr, "virt_cpu_total", NULL, &(value_t){.derive = cpuTime_new},
980          1);
981 }
982
983 static void vcpu_submit(derive_t value, virDomainPtr dom, int vcpu_nr,
984                         const char *type) {
985   char type_instance[DATA_MAX_NAME_LEN];
986
987   snprintf(type_instance, sizeof(type_instance), "%d", vcpu_nr);
988   submit(dom, type, type_instance, &(value_t){.derive = value}, 1);
989 }
990
991 static void disk_block_stats_submit(struct lv_block_stats *bstats,
992                                     virDomainPtr dom, const char *dev,
993                                     virDomainBlockInfoPtr binfo) {
994   char *dev_copy = strdup(dev);
995   const char *type_instance = dev_copy;
996
997   if (!dev_copy)
998     return;
999
1000   if (blockdevice_format_basename && blockdevice_format == source)
1001     type_instance = basename(dev_copy);
1002
1003   if (!type_instance) {
1004     sfree(dev_copy);
1005     return;
1006   }
1007
1008   char flush_type_instance[DATA_MAX_NAME_LEN];
1009   snprintf(flush_type_instance, sizeof(flush_type_instance), "flush-%s",
1010            type_instance);
1011
1012   if ((bstats->bi.rd_req != -1) && (bstats->bi.wr_req != -1))
1013     submit_derive2("disk_ops", (derive_t)bstats->bi.rd_req,
1014                    (derive_t)bstats->bi.wr_req, dom, type_instance);
1015
1016   if ((bstats->bi.rd_bytes != -1) && (bstats->bi.wr_bytes != -1))
1017     submit_derive2("disk_octets", (derive_t)bstats->bi.rd_bytes,
1018                    (derive_t)bstats->bi.wr_bytes, dom, type_instance);
1019
1020   if (extra_stats & ex_stats_disk) {
1021     if ((bstats->rd_total_times != -1) && (bstats->wr_total_times != -1))
1022       submit_derive2("disk_time", (derive_t)bstats->rd_total_times,
1023                      (derive_t)bstats->wr_total_times, dom, type_instance);
1024
1025     if (bstats->fl_req != -1)
1026       submit(dom, "total_requests", flush_type_instance,
1027              &(value_t){.derive = (derive_t)bstats->fl_req}, 1);
1028     if (bstats->fl_total_times != -1) {
1029       derive_t value = bstats->fl_total_times / 1000; // ns -> ms
1030       submit(dom, "total_time_in_ms", flush_type_instance,
1031              &(value_t){.derive = value}, 1);
1032     }
1033   }
1034
1035   /* disk_allocation, disk_capacity and disk_physical are stored only
1036    * if corresponding extrastats are set in collectd configuration file */
1037   if ((extra_stats & ex_stats_disk_allocation) && binfo->allocation != -1)
1038     submit(dom, "disk_allocation", type_instance,
1039            &(value_t){.gauge = (gauge_t)binfo->allocation}, 1);
1040
1041   if ((extra_stats & ex_stats_disk_capacity) && binfo->capacity != -1)
1042     submit(dom, "disk_capacity", type_instance,
1043            &(value_t){.gauge = (gauge_t)binfo->capacity}, 1);
1044
1045   if ((extra_stats & ex_stats_disk_physical) && binfo->physical != -1)
1046     submit(dom, "disk_physical", type_instance,
1047            &(value_t){.gauge = (gauge_t)binfo->physical}, 1);
1048
1049   sfree(dev_copy);
1050 }
1051
1052 /**
1053  * Function for parsing ExtraStats configuration options.
1054  * Result of parsing is stored under 'out_parsed_flags' pointer.
1055  *
1056  * Returns 0 in case of success and 1 in case of parsing error
1057  */
1058 static int parse_ex_stats_flags(unsigned int *out_parsed_flags, char **exstats,
1059                                 int numexstats) {
1060   unsigned int ex_stats_flags = ex_stats_none;
1061
1062   assert(out_parsed_flags != NULL);
1063
1064   for (int i = 0; i < numexstats; i++) {
1065     for (int j = 0; ex_stats_table[j].name != NULL; j++) {
1066       if (strcasecmp(exstats[i], ex_stats_table[j].name) == 0) {
1067         DEBUG(PLUGIN_NAME " plugin: enabling extra stats for '%s'",
1068               ex_stats_table[j].name);
1069         ex_stats_flags |= ex_stats_table[j].flag;
1070         break;
1071       }
1072
1073       if (ex_stats_table[j + 1].name == NULL) {
1074         ERROR(PLUGIN_NAME " plugin: Unmatched ExtraStats option: %s",
1075               exstats[i]);
1076         return 1;
1077       }
1078     }
1079   }
1080
1081   *out_parsed_flags = ex_stats_flags;
1082   return 0;
1083 }
1084
1085 static void domain_state_submit_notif(virDomainPtr dom, int state, int reason) {
1086   if ((state < 0) || ((size_t)state >= STATIC_ARRAY_SIZE(domain_states))) {
1087     ERROR(PLUGIN_NAME " plugin: Array index out of bounds: state=%d", state);
1088     return;
1089   }
1090
1091   char msg[DATA_MAX_NAME_LEN];
1092   const char *state_str = domain_states[state];
1093 #ifdef HAVE_DOM_REASON
1094   if ((reason < 0) ||
1095       ((size_t)reason >= STATIC_ARRAY_SIZE(domain_reasons[0]))) {
1096     ERROR(PLUGIN_NAME " plugin: Array index out of bounds: reason=%d", reason);
1097     return;
1098   }
1099
1100   const char *reason_str = domain_reasons[state][reason];
1101   /* Array size for domain reasons is fixed, but different domain states can
1102    * have different number of reasons. We need to check if reason was
1103    * successfully parsed */
1104   if (!reason_str) {
1105     ERROR(PLUGIN_NAME " plugin: Invalid reason (%d) for domain state: %s",
1106           reason, state_str);
1107     return;
1108   }
1109 #else
1110   const char *reason_str = "N/A";
1111 #endif
1112
1113   snprintf(msg, sizeof(msg), "Domain state: %s. Reason: %s", state_str,
1114            reason_str);
1115
1116   int severity;
1117   switch (state) {
1118   case VIR_DOMAIN_NOSTATE:
1119   case VIR_DOMAIN_RUNNING:
1120   case VIR_DOMAIN_SHUTDOWN:
1121   case VIR_DOMAIN_SHUTOFF:
1122     severity = NOTIF_OKAY;
1123     break;
1124   case VIR_DOMAIN_BLOCKED:
1125   case VIR_DOMAIN_PAUSED:
1126 #ifdef DOM_STATE_PMSUSPENDED
1127   case VIR_DOMAIN_PMSUSPENDED:
1128 #endif
1129     severity = NOTIF_WARNING;
1130     break;
1131   case VIR_DOMAIN_CRASHED:
1132     severity = NOTIF_FAILURE;
1133     break;
1134   default:
1135     ERROR(PLUGIN_NAME " plugin: Unrecognized domain state (%d)", state);
1136     return;
1137   }
1138   submit_notif(dom, severity, msg, "domain_state", NULL);
1139 }
1140
1141 static int lv_init_ignorelists() {
1142   if (il_domains == NULL)
1143     il_domains = ignorelist_create(1);
1144   if (il_block_devices == NULL)
1145     il_block_devices = ignorelist_create(1);
1146   if (il_interface_devices == NULL)
1147     il_interface_devices = ignorelist_create(1);
1148
1149   if (!il_domains || !il_block_devices || !il_interface_devices)
1150     return 1;
1151
1152   return 0;
1153 }
1154
1155 /* Validates config option that may take multiple strings arguments.
1156  * Returns 0 on success, -1 otherwise */
1157 static int check_config_multiple_string_entry(const oconfig_item_t *ci) {
1158   if (ci == NULL) {
1159     ERROR(PLUGIN_NAME " plugin: ci oconfig_item can't be NULL");
1160     return -1;
1161   }
1162
1163   if (ci->values_num < 1) {
1164     ERROR(PLUGIN_NAME
1165           " plugin: the '%s' option requires at least one string argument",
1166           ci->key);
1167     return -1;
1168   }
1169
1170   for (int i = 0; i < ci->values_num; ++i) {
1171     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
1172       ERROR(PLUGIN_NAME
1173             " plugin: one of the '%s' options is not a valid string",
1174             ci->key);
1175       return -1;
1176     }
1177   }
1178
1179   return 0;
1180 }
1181
1182 static int lv_config(oconfig_item_t *ci) {
1183   if (lv_init_ignorelists() != 0) {
1184     ERROR(PLUGIN_NAME " plugin: lv_init_ignorelist failed.");
1185     return -1;
1186   }
1187
1188   for (int i = 0; i < ci->children_num; ++i) {
1189     oconfig_item_t *c = ci->children + i;
1190
1191     if (strcasecmp(c->key, "Connection") == 0) {
1192       if (cf_util_get_string(c, &conn_string) != 0 || conn_string == NULL) {
1193         ERROR(PLUGIN_NAME " plugin: Could not get 'Connection' parameter");
1194         return -1;
1195       }
1196
1197       continue;
1198     } else if (strcasecmp(c->key, "RefreshInterval") == 0) {
1199       if (cf_util_get_int(c, &interval) != 0) {
1200         ERROR(PLUGIN_NAME " plugin: Could not get 'RefreshInterval' parameter");
1201         return -1;
1202       }
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 || domain_name == NULL) {
1208         ERROR(PLUGIN_NAME " plugin: Could not get 'Domain' parameter");
1209         return -1;
1210       }
1211
1212       if (ignorelist_add(il_domains, domain_name)) {
1213         ERROR(PLUGIN_NAME " plugin: Adding '%s' to domain-ignorelist failed",
1214               domain_name);
1215         sfree(domain_name);
1216         return -1;
1217       }
1218
1219       sfree(domain_name);
1220       continue;
1221     } else if (strcasecmp(c->key, "BlockDevice") == 0) {
1222       char *device_name = NULL;
1223       if (cf_util_get_string(c, &device_name) != 0 || device_name == NULL) {
1224         ERROR(PLUGIN_NAME " plugin: Could not get 'BlockDevice' parameter");
1225         return -1;
1226       }
1227
1228       if (ignorelist_add(il_block_devices, device_name) != 0) {
1229         ERROR(PLUGIN_NAME
1230               " plugin: Adding '%s' to block-device-ignorelist failed",
1231               device_name);
1232         sfree(device_name);
1233         return -1;
1234       }
1235
1236       sfree(device_name);
1237       continue;
1238     } else if (strcasecmp(c->key, "BlockDeviceFormat") == 0) {
1239       char *device_format = NULL;
1240       if (cf_util_get_string(c, &device_format) != 0 || device_format == NULL) {
1241         ERROR(PLUGIN_NAME
1242               " plugin: Could not get 'BlockDeviceFormat' parameter");
1243         return -1;
1244       }
1245
1246       if (strcasecmp(device_format, "target") == 0)
1247         blockdevice_format = target;
1248       else if (strcasecmp(device_format, "source") == 0)
1249         blockdevice_format = source;
1250       else {
1251         ERROR(PLUGIN_NAME " plugin: unknown BlockDeviceFormat: %s",
1252               device_format);
1253         sfree(device_format);
1254         return -1;
1255       }
1256
1257       sfree(device_format);
1258       continue;
1259     } else if (strcasecmp(c->key, "BlockDeviceFormatBasename") == 0) {
1260       if (cf_util_get_boolean(c, &blockdevice_format_basename) != 0) {
1261         ERROR(PLUGIN_NAME
1262               " plugin: Could not get 'BlockDeviceFormatBasename' parameter");
1263         return -1;
1264       }
1265
1266       continue;
1267     } else if (strcasecmp(c->key, "InterfaceDevice") == 0) {
1268       char *interface_name = NULL;
1269       if (cf_util_get_string(c, &interface_name) != 0 ||
1270           interface_name == NULL) {
1271         ERROR(PLUGIN_NAME " plugin: Could not get 'InterfaceDevice' parameter");
1272         return -1;
1273       }
1274
1275       if (ignorelist_add(il_interface_devices, interface_name)) {
1276         ERROR(PLUGIN_NAME " plugin: Adding '%s' to interface-ignorelist failed",
1277               interface_name);
1278         sfree(interface_name);
1279         return -1;
1280       }
1281
1282       sfree(interface_name);
1283       continue;
1284     } else if (strcasecmp(c->key, "IgnoreSelected") == 0) {
1285       bool ignore_selected = false;
1286       if (cf_util_get_boolean(c, &ignore_selected) != 0) {
1287         ERROR(PLUGIN_NAME " plugin: Could not get 'IgnoreSelected' parameter");
1288         return -1;
1289       }
1290
1291       if (ignore_selected) {
1292         ignorelist_set_invert(il_domains, 0);
1293         ignorelist_set_invert(il_block_devices, 0);
1294         ignorelist_set_invert(il_interface_devices, 0);
1295       } else {
1296         ignorelist_set_invert(il_domains, 1);
1297         ignorelist_set_invert(il_block_devices, 1);
1298         ignorelist_set_invert(il_interface_devices, 1);
1299       }
1300
1301       continue;
1302     } else if (strcasecmp(c->key, "HostnameMetadataNS") == 0) {
1303       if (cf_util_get_string(c, &hm_ns) != 0) {
1304         ERROR(PLUGIN_NAME
1305               " plugin: Could not get 'HostnameMetadataNS' parameter");
1306         return -1;
1307       }
1308
1309       continue;
1310     } else if (strcasecmp(c->key, "HostnameMetadataXPath") == 0) {
1311       if (cf_util_get_string(c, &hm_xpath) != 0) {
1312         ERROR(PLUGIN_NAME
1313               " plugin: Could not get 'HostnameMetadataXPath' parameter");
1314         return -1;
1315       }
1316
1317       continue;
1318     } else if (strcasecmp(c->key, "HostnameFormat") == 0) {
1319       /* this option can take multiple strings arguments in one config line*/
1320       if (check_config_multiple_string_entry(c) != 0) {
1321         ERROR(PLUGIN_NAME " plugin: Could not get 'HostnameFormat' parameter");
1322         return -1;
1323       }
1324
1325       const int params_num = c->values_num;
1326       for (int i = 0; i < params_num; ++i) {
1327         const char *param_name = c->values[i].value.string;
1328         if (strcasecmp(param_name, "hostname") == 0)
1329           hostname_format[i] = hf_hostname;
1330         else if (strcasecmp(param_name, "name") == 0)
1331           hostname_format[i] = hf_name;
1332         else if (strcasecmp(param_name, "uuid") == 0)
1333           hostname_format[i] = hf_uuid;
1334         else if (strcasecmp(param_name, "metadata") == 0)
1335           hostname_format[i] = hf_metadata;
1336         else {
1337           ERROR(PLUGIN_NAME " plugin: unknown HostnameFormat field: %s",
1338                 param_name);
1339           return -1;
1340         }
1341       }
1342
1343       for (int i = params_num; i < HF_MAX_FIELDS; ++i)
1344         hostname_format[i] = hf_none;
1345
1346       continue;
1347     } else if (strcasecmp(c->key, "PluginInstanceFormat") == 0) {
1348       /* this option can handle list of string parameters in one line*/
1349       if (check_config_multiple_string_entry(c) != 0) {
1350         ERROR(PLUGIN_NAME
1351               " plugin: Could not get 'PluginInstanceFormat' parameter");
1352         return -1;
1353       }
1354
1355       const int params_num = c->values_num;
1356       for (int i = 0; i < params_num; ++i) {
1357         const char *param_name = c->values[i].value.string;
1358         if (strcasecmp(param_name, "none") == 0) {
1359           plugin_instance_format[i] = plginst_none;
1360           break;
1361         } else if (strcasecmp(param_name, "name") == 0)
1362           plugin_instance_format[i] = plginst_name;
1363         else if (strcasecmp(param_name, "uuid") == 0)
1364           plugin_instance_format[i] = plginst_uuid;
1365         else if (strcasecmp(param_name, "metadata") == 0)
1366           plugin_instance_format[i] = plginst_metadata;
1367         else {
1368           ERROR(PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s",
1369                 param_name);
1370
1371           return -1;
1372         }
1373       }
1374
1375       for (int i = params_num; i < PLGINST_MAX_FIELDS; ++i)
1376         plugin_instance_format[i] = plginst_none;
1377
1378       continue;
1379     } else if (strcasecmp(c->key, "InterfaceFormat") == 0) {
1380       char *format = NULL;
1381       if (cf_util_get_string(c, &format) != 0 || format == NULL) {
1382         ERROR(PLUGIN_NAME " plugin: could not get 'InterfaceFormat' parameter");
1383         return -1;
1384       }
1385
1386       if (strcasecmp(format, "name") == 0)
1387         interface_format = if_name;
1388       else if (strcasecmp(format, "address") == 0)
1389         interface_format = if_address;
1390       else if (strcasecmp(format, "number") == 0)
1391         interface_format = if_number;
1392       else {
1393         ERROR(PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", format);
1394         sfree(format);
1395         return -1;
1396       }
1397
1398       sfree(format);
1399       continue;
1400     } else if (strcasecmp(c->key, "Instances") == 0) {
1401       if (cf_util_get_int(c, &nr_instances) != 0) {
1402         ERROR(PLUGIN_NAME " plugin: could not get 'Instances' parameter");
1403         return -1;
1404       }
1405
1406       if (nr_instances <= 0) {
1407         ERROR(PLUGIN_NAME " plugin: Instances <= 0 makes no sense.");
1408         return -1;
1409       }
1410       if (nr_instances > NR_INSTANCES_MAX) {
1411         ERROR(PLUGIN_NAME " plugin: Instances=%i > NR_INSTANCES_MAX=%i"
1412                           " use a lower setting or recompile the plugin.",
1413               nr_instances, NR_INSTANCES_MAX);
1414         return -1;
1415       }
1416
1417       DEBUG(PLUGIN_NAME " plugin: configured %i instances", nr_instances);
1418       continue;
1419     } else if (strcasecmp(c->key, "ExtraStats") == 0) {
1420       char *ex_str = NULL;
1421
1422       if (cf_util_get_string(c, &ex_str) != 0 || ex_str == NULL) {
1423         ERROR(PLUGIN_NAME " plugin: could not get 'ExtraStats' parameter");
1424         return -1;
1425       }
1426
1427       char *exstats[EX_STATS_MAX_FIELDS];
1428       int numexstats = strsplit(ex_str, exstats, STATIC_ARRAY_SIZE(exstats));
1429       int status = parse_ex_stats_flags(&extra_stats, exstats, numexstats);
1430       sfree(ex_str);
1431       if (status != 0) {
1432         ERROR(PLUGIN_NAME " plugin: parsing 'ExtraStats' option failed");
1433         return status;
1434       }
1435
1436 #ifdef HAVE_JOB_STATS
1437       if ((extra_stats & ex_stats_job_stats_completed) &&
1438           (extra_stats & ex_stats_job_stats_background)) {
1439         ERROR(PLUGIN_NAME " plugin: Invalid job stats configuration. Only one "
1440                           "type of job statistics can be collected at the same "
1441                           "time");
1442         return -1;
1443       }
1444 #endif
1445
1446       /* ExtraStats parsed successfully*/
1447       continue;
1448     } else if (strcasecmp(c->key, "PersistentNotification") == 0) {
1449       if (cf_util_get_boolean(c, &persistent_notification) != 0) {
1450         ERROR(PLUGIN_NAME
1451               " plugin: could not get 'PersistentNotification' parameter");
1452         return -1;
1453       }
1454
1455       continue;
1456     } else if (strcasecmp(c->key, "ReportBlockDevices") == 0) {
1457       if (cf_util_get_boolean(c, &report_block_devices) != 0) {
1458         ERROR(PLUGIN_NAME
1459               " plugin: could not get 'ReportBlockDevices' parameter");
1460         return -1;
1461       }
1462
1463       continue;
1464     } else if (strcasecmp(c->key, "ReportNetworkInterfaces") == 0) {
1465       if (cf_util_get_boolean(c, &report_network_interfaces) != 0) {
1466         ERROR(PLUGIN_NAME
1467               " plugin: could not get 'ReportNetworkInterfaces' parameter");
1468         return -1;
1469       }
1470
1471       continue;
1472     } else {
1473       /* Unrecognised option. */
1474       ERROR(PLUGIN_NAME " plugin: Unrecognized option: '%s'", c->key);
1475       return -1;
1476     }
1477   }
1478
1479   return 0;
1480 }
1481
1482 static int lv_connect(void) {
1483   if (conn == NULL) {
1484 /* `conn_string == NULL' is acceptable */
1485 #ifdef HAVE_FS_INFO
1486     /* virDomainGetFSInfo requires full read-write access connection */
1487     if (extra_stats & ex_stats_fs_info)
1488       conn = virConnectOpen(conn_string);
1489     else
1490 #endif
1491       conn = virConnectOpenReadOnly(conn_string);
1492     if (conn == NULL) {
1493       c_complain(LOG_ERR, &conn_complain,
1494                  PLUGIN_NAME " plugin: Unable to connect: "
1495                              "virConnectOpen failed.");
1496       return -1;
1497     }
1498     int status = virNodeGetInfo(conn, &nodeinfo);
1499     if (status != 0) {
1500       ERROR(PLUGIN_NAME " plugin: virNodeGetInfo failed");
1501       return -1;
1502     }
1503   }
1504   c_release(LOG_NOTICE, &conn_complain,
1505             PLUGIN_NAME " plugin: Connection established.");
1506   return 0;
1507 }
1508
1509 static void lv_disconnect(void) {
1510   if (conn != NULL)
1511     virConnectClose(conn);
1512   conn = NULL;
1513   WARNING(PLUGIN_NAME " plugin: closed connection to libvirt");
1514 }
1515
1516 static int lv_domain_block_stats(virDomainPtr dom, const char *path,
1517                                  struct lv_block_stats *bstats) {
1518 #ifdef HAVE_BLOCK_STATS_FLAGS
1519   int nparams = 0;
1520   if (virDomainBlockStatsFlags(dom, path, NULL, &nparams, 0) < 0 ||
1521       nparams <= 0) {
1522     VIRT_ERROR(conn, "getting the disk params count");
1523     return -1;
1524   }
1525
1526   virTypedParameterPtr params = calloc(nparams, sizeof(*params));
1527   if (params == NULL) {
1528     ERROR("virt plugin: alloc(%i) for block=%s parameters failed.", nparams,
1529           path);
1530     return -1;
1531   }
1532
1533   int rc = -1;
1534   if (virDomainBlockStatsFlags(dom, path, params, &nparams, 0) < 0) {
1535     VIRT_ERROR(conn, "getting the disk params values");
1536   } else {
1537     rc = get_block_stats(bstats, params, nparams);
1538   }
1539
1540   virTypedParamsClear(params, nparams);
1541   sfree(params);
1542   return rc;
1543 #else
1544   return virDomainBlockStats(dom, path, &(bstats->bi), sizeof(bstats->bi));
1545 #endif /* HAVE_BLOCK_STATS_FLAGS */
1546 }
1547
1548 #ifdef HAVE_PERF_STATS
1549 static void perf_submit(virDomainStatsRecordPtr stats) {
1550   for (int i = 0; i < stats->nparams; ++i) {
1551     /* Replace '.' with '_' in event field to match other metrics' naming
1552      * convention */
1553     char *c = strchr(stats->params[i].field, '.');
1554     if (c)
1555       *c = '_';
1556     submit(stats->dom, "perf", stats->params[i].field,
1557            &(value_t){.derive = stats->params[i].value.ul}, 1);
1558   }
1559 }
1560
1561 static int get_perf_events(virDomainPtr domain) {
1562   virDomainStatsRecordPtr *stats = NULL;
1563   /* virDomainListGetStats requires a NULL terminated list of domains */
1564   virDomainPtr domain_array[] = {domain, NULL};
1565
1566   int status =
1567       virDomainListGetStats(domain_array, VIR_DOMAIN_STATS_PERF, &stats, 0);
1568   if (status == -1) {
1569     ERROR("virt plugin: virDomainListGetStats failed with status %i.", status);
1570     return status;
1571   }
1572
1573   for (int i = 0; i < status; ++i)
1574     perf_submit(stats[i]);
1575
1576   virDomainStatsRecordListFree(stats);
1577   return 0;
1578 }
1579 #endif /* HAVE_PERF_STATS */
1580
1581 static void vcpu_pin_submit(virDomainPtr dom, int max_cpus, int vcpu,
1582                             unsigned char *cpu_maps, int cpu_map_len) {
1583   for (int cpu = 0; cpu < max_cpus; ++cpu) {
1584     char type_instance[DATA_MAX_NAME_LEN];
1585     bool is_set = VIR_CPU_USABLE(cpu_maps, cpu_map_len, vcpu, cpu);
1586
1587     snprintf(type_instance, sizeof(type_instance), "vcpu_%d-cpu_%d", vcpu, cpu);
1588     submit(dom, "cpu_affinity", type_instance, &(value_t){.gauge = is_set}, 1);
1589   }
1590 }
1591
1592 static int get_vcpu_stats(virDomainPtr domain, unsigned short nr_virt_cpu) {
1593   int max_cpus = VIR_NODEINFO_MAXCPUS(nodeinfo);
1594   int cpu_map_len = VIR_CPU_MAPLEN(max_cpus);
1595
1596   virVcpuInfoPtr vinfo = calloc(nr_virt_cpu, sizeof(*vinfo));
1597   if (vinfo == NULL) {
1598     ERROR(PLUGIN_NAME " plugin: calloc failed.");
1599     return -1;
1600   }
1601
1602   unsigned char *cpumaps = calloc(nr_virt_cpu, cpu_map_len);
1603   if (cpumaps == NULL) {
1604     ERROR(PLUGIN_NAME " plugin: calloc failed.");
1605     sfree(vinfo);
1606     return -1;
1607   }
1608
1609   int status =
1610       virDomainGetVcpus(domain, vinfo, nr_virt_cpu, cpumaps, cpu_map_len);
1611   if (status < 0) {
1612     ERROR(PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
1613           status);
1614     sfree(cpumaps);
1615     sfree(vinfo);
1616     return status;
1617   }
1618
1619   for (int i = 0; i < nr_virt_cpu; ++i) {
1620     vcpu_submit(vinfo[i].cpuTime, domain, vinfo[i].number, "virt_vcpu");
1621     if (extra_stats & ex_stats_vcpupin)
1622       vcpu_pin_submit(domain, max_cpus, i, cpumaps, cpu_map_len);
1623   }
1624
1625   sfree(cpumaps);
1626   sfree(vinfo);
1627   return 0;
1628 }
1629
1630 #ifdef HAVE_CPU_STATS
1631 static int get_pcpu_stats(virDomainPtr dom) {
1632   int nparams = virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0);
1633   if (nparams < 0) {
1634     VIRT_ERROR(conn, "getting the CPU params count");
1635     return -1;
1636   }
1637
1638   virTypedParameterPtr param = calloc(nparams, sizeof(*param));
1639   if (param == NULL) {
1640     ERROR(PLUGIN_NAME " plugin: alloc(%i) for cpu parameters failed.", nparams);
1641     return -1;
1642   }
1643
1644   int ret = virDomainGetCPUStats(dom, param, nparams, -1, 1, 0); // total stats.
1645   if (ret < 0) {
1646     virTypedParamsClear(param, nparams);
1647     sfree(param);
1648     VIRT_ERROR(conn, "getting the CPU params values");
1649     return -1;
1650   }
1651
1652   unsigned long long total_user_cpu_time = 0;
1653   unsigned long long total_syst_cpu_time = 0;
1654
1655   for (int i = 0; i < nparams; ++i) {
1656     if (!strcmp(param[i].field, "user_time"))
1657       total_user_cpu_time = param[i].value.ul;
1658     else if (!strcmp(param[i].field, "system_time"))
1659       total_syst_cpu_time = param[i].value.ul;
1660   }
1661
1662   if (total_user_cpu_time > 0 || total_syst_cpu_time > 0)
1663     submit_derive2("ps_cputime", total_user_cpu_time, total_syst_cpu_time, dom,
1664                    NULL);
1665
1666   virTypedParamsClear(param, nparams);
1667   sfree(param);
1668
1669   return 0;
1670 }
1671 #endif /* HAVE_CPU_STATS */
1672
1673 #ifdef HAVE_DOM_REASON
1674
1675 static void domain_state_submit(virDomainPtr dom, int state, int reason) {
1676   value_t values[] = {
1677       {.gauge = (gauge_t)state}, {.gauge = (gauge_t)reason},
1678   };
1679
1680   submit(dom, "domain_state", NULL, values, STATIC_ARRAY_SIZE(values));
1681 }
1682
1683 static int get_domain_state(virDomainPtr domain) {
1684   int domain_state = 0;
1685   int domain_reason = 0;
1686
1687   int status = virDomainGetState(domain, &domain_state, &domain_reason, 0);
1688   if (status != 0) {
1689     ERROR(PLUGIN_NAME " plugin: virDomainGetState failed with status %i.",
1690           status);
1691     return status;
1692   }
1693
1694   domain_state_submit(domain, domain_state, domain_reason);
1695
1696   return status;
1697 }
1698
1699 #ifdef HAVE_LIST_ALL_DOMAINS
1700 static int get_domain_state_notify(virDomainPtr domain) {
1701   int domain_state = 0;
1702   int domain_reason = 0;
1703
1704   int status = virDomainGetState(domain, &domain_state, &domain_reason, 0);
1705   if (status != 0) {
1706     ERROR(PLUGIN_NAME " plugin: virDomainGetState failed with status %i.",
1707           status);
1708     return status;
1709   }
1710
1711   if (persistent_notification)
1712     domain_state_submit_notif(domain, domain_state, domain_reason);
1713
1714   return status;
1715 }
1716 #endif /* HAVE_LIST_ALL_DOMAINS */
1717 #endif /* HAVE_DOM_REASON */
1718
1719 static int get_memory_stats(virDomainPtr domain) {
1720   virDomainMemoryStatPtr minfo =
1721       calloc(VIR_DOMAIN_MEMORY_STAT_NR, sizeof(*minfo));
1722   if (minfo == NULL) {
1723     ERROR("virt plugin: calloc failed.");
1724     return -1;
1725   }
1726
1727   int mem_stats =
1728       virDomainMemoryStats(domain, minfo, VIR_DOMAIN_MEMORY_STAT_NR, 0);
1729   if (mem_stats < 0) {
1730     ERROR("virt plugin: virDomainMemoryStats failed with mem_stats %i.",
1731           mem_stats);
1732     sfree(minfo);
1733     return mem_stats;
1734   }
1735
1736   for (int i = 0; i < mem_stats; i++)
1737     memory_stats_submit((gauge_t)minfo[i].val * 1024, domain, minfo[i].tag);
1738
1739   sfree(minfo);
1740   return 0;
1741 }
1742
1743 #ifdef HAVE_DISK_ERR
1744 static void disk_err_submit(virDomainPtr domain,
1745                             virDomainDiskErrorPtr disk_err) {
1746   submit(domain, "disk_error", disk_err->disk,
1747          &(value_t){.gauge = disk_err->error}, 1);
1748 }
1749
1750 static int get_disk_err(virDomainPtr domain) {
1751   /* Get preferred size of disk errors array */
1752   int disk_err_count = virDomainGetDiskErrors(domain, NULL, 0, 0);
1753   if (disk_err_count == -1) {
1754     ERROR(PLUGIN_NAME
1755           " plugin: failed to get preferred size of disk errors array");
1756     return -1;
1757   }
1758
1759   DEBUG(PLUGIN_NAME
1760         " plugin: preferred size of disk errors array: %d for domain %s",
1761         disk_err_count, virDomainGetName(domain));
1762   virDomainDiskError disk_err[disk_err_count];
1763
1764   disk_err_count = virDomainGetDiskErrors(domain, disk_err, disk_err_count, 0);
1765   if (disk_err_count == -1) {
1766     ERROR(PLUGIN_NAME " plugin: virDomainGetDiskErrors failed with status %d",
1767           disk_err_count);
1768     return -1;
1769   }
1770
1771   DEBUG(PLUGIN_NAME " plugin: detected %d disk errors in domain %s",
1772         disk_err_count, virDomainGetName(domain));
1773
1774   for (int i = 0; i < disk_err_count; ++i) {
1775     disk_err_submit(domain, &disk_err[i]);
1776     sfree(disk_err[i].disk);
1777   }
1778
1779   return 0;
1780 }
1781 #endif /* HAVE_DISK_ERR */
1782
1783 static int get_block_device_stats(struct block_device *block_dev) {
1784   if (!block_dev) {
1785     ERROR(PLUGIN_NAME " plugin: get_block_stats NULL pointer");
1786     return -1;
1787   }
1788
1789   virDomainBlockInfo binfo;
1790   init_block_info(&binfo);
1791
1792   /* Fetching block info stats only if needed*/
1793   if (extra_stats & (ex_stats_disk_allocation | ex_stats_disk_capacity |
1794                      ex_stats_disk_physical)) {
1795     /* Block info statistics can be only fetched from devices with 'source'
1796      * defined */
1797     if (block_dev->has_source) {
1798       if (virDomainGetBlockInfo(block_dev->dom, block_dev->path, &binfo, 0) <
1799           0) {
1800         ERROR(PLUGIN_NAME " plugin: virDomainGetBlockInfo failed for path: %s",
1801               block_dev->path);
1802         return -1;
1803       }
1804     }
1805   }
1806
1807   struct lv_block_stats bstats;
1808   init_block_stats(&bstats);
1809
1810   if (lv_domain_block_stats(block_dev->dom, block_dev->path, &bstats) < 0) {
1811     ERROR(PLUGIN_NAME " plugin: lv_domain_block_stats failed");
1812     return -1;
1813   }
1814
1815   disk_block_stats_submit(&bstats, block_dev->dom, block_dev->path, &binfo);
1816   return 0;
1817 }
1818
1819 #ifdef HAVE_FS_INFO
1820
1821 #define NM_ADD_ITEM(_fun, _name, _val)                                         \
1822   do {                                                                         \
1823     ret = _fun(&notif, _name, _val);                                           \
1824     if (ret != 0) {                                                            \
1825       ERROR(PLUGIN_NAME " plugin: failed to add notification metadata");       \
1826       goto cleanup;                                                            \
1827     }                                                                          \
1828   } while (0)
1829
1830 #define NM_ADD_STR_ITEMS(_items, _size)                                        \
1831   do {                                                                         \
1832     for (size_t _i = 0; _i < _size; ++_i) {                                    \
1833       DEBUG(PLUGIN_NAME                                                        \
1834             " plugin: Adding notification metadata name=%s value=%s",          \
1835             _items[_i].name, _items[_i].value);                                \
1836       NM_ADD_ITEM(plugin_notification_meta_add_string, _items[_i].name,        \
1837                   _items[_i].value);                                           \
1838     }                                                                          \
1839   } while (0)
1840
1841 static int fs_info_notify(virDomainPtr domain, virDomainFSInfoPtr fs_info) {
1842   notification_t notif;
1843   int ret = 0;
1844
1845   /* Local struct, just for the purpose of this function. */
1846   typedef struct nm_str_item_s {
1847     const char *name;
1848     const char *value;
1849   } nm_str_item_t;
1850
1851   nm_str_item_t fs_dev_alias[fs_info->ndevAlias];
1852   nm_str_item_t fs_str_items[] = {
1853       {.name = "mountpoint", .value = fs_info->mountpoint},
1854       {.name = "name", .value = fs_info->name},
1855       {.name = "fstype", .value = fs_info->fstype}};
1856
1857   for (size_t i = 0; i < fs_info->ndevAlias; ++i) {
1858     fs_dev_alias[i].name = "devAlias";
1859     fs_dev_alias[i].value = fs_info->devAlias[i];
1860   }
1861
1862   init_notif(&notif, domain, NOTIF_OKAY, "File system information",
1863              "file_system", NULL);
1864   NM_ADD_STR_ITEMS(fs_str_items, STATIC_ARRAY_SIZE(fs_str_items));
1865   NM_ADD_ITEM(plugin_notification_meta_add_unsigned_int, "ndevAlias",
1866               fs_info->ndevAlias);
1867   NM_ADD_STR_ITEMS(fs_dev_alias, fs_info->ndevAlias);
1868
1869   plugin_dispatch_notification(&notif);
1870
1871 cleanup:
1872   if (notif.meta)
1873     plugin_notification_meta_free(notif.meta);
1874   return ret;
1875 }
1876
1877 #undef RETURN_ON_ERR
1878 #undef NM_ADD_STR_ITEMS
1879
1880 static int get_fs_info(virDomainPtr domain) {
1881   virDomainFSInfoPtr *fs_info = NULL;
1882   int ret = 0;
1883
1884   int mount_points_cnt = virDomainGetFSInfo(domain, &fs_info, 0);
1885   if (mount_points_cnt == -1) {
1886     ERROR(PLUGIN_NAME " plugin: virDomainGetFSInfo failed: %d",
1887           mount_points_cnt);
1888     return mount_points_cnt;
1889   }
1890
1891   for (int i = 0; i < mount_points_cnt; ++i) {
1892     if (fs_info_notify(domain, fs_info[i]) != 0) {
1893       ERROR(PLUGIN_NAME " plugin: failed to send file system notification "
1894                         "for mount point %s",
1895             fs_info[i]->mountpoint);
1896       ret = -1;
1897     }
1898     virDomainFSInfoFree(fs_info[i]);
1899   }
1900
1901   sfree(fs_info);
1902   return ret;
1903 }
1904
1905 #endif /* HAVE_FS_INFO */
1906
1907 #ifdef HAVE_JOB_STATS
1908 static void job_stats_submit(virDomainPtr domain, virTypedParameterPtr param) {
1909   value_t vl = {0};
1910
1911   if (param->type == VIR_TYPED_PARAM_INT)
1912     vl.derive = param->value.i;
1913   else if (param->type == VIR_TYPED_PARAM_UINT)
1914     vl.derive = param->value.ui;
1915   else if (param->type == VIR_TYPED_PARAM_LLONG)
1916     vl.derive = param->value.l;
1917   else if (param->type == VIR_TYPED_PARAM_ULLONG)
1918     vl.derive = param->value.ul;
1919   else if (param->type == VIR_TYPED_PARAM_DOUBLE)
1920     vl.derive = param->value.d;
1921   else if (param->type == VIR_TYPED_PARAM_BOOLEAN)
1922     vl.derive = param->value.b;
1923   else if (param->type == VIR_TYPED_PARAM_STRING) {
1924     submit_notif(domain, NOTIF_OKAY, param->value.s, "job_stats", param->field);
1925     return;
1926   } else {
1927     ERROR(PLUGIN_NAME " plugin: unrecognized virTypedParameterType");
1928     return;
1929   }
1930
1931   submit(domain, "job_stats", param->field, &vl, 1);
1932 }
1933
1934 static int get_job_stats(virDomainPtr domain) {
1935   int ret = 0;
1936   int job_type = 0;
1937   int nparams = 0;
1938   virTypedParameterPtr params = NULL;
1939   int flags = (extra_stats & ex_stats_job_stats_completed)
1940                   ? VIR_DOMAIN_JOB_STATS_COMPLETED
1941                   : 0;
1942
1943   ret = virDomainGetJobStats(domain, &job_type, &params, &nparams, flags);
1944   if (ret != 0) {
1945     ERROR(PLUGIN_NAME " plugin: virDomainGetJobStats failed: %d", ret);
1946     return ret;
1947   }
1948
1949   DEBUG(PLUGIN_NAME " plugin: job_type=%d nparams=%d", job_type, nparams);
1950
1951   for (int i = 0; i < nparams; ++i) {
1952     DEBUG(PLUGIN_NAME " plugin: param[%d] field=%s type=%d", i, params[i].field,
1953           params[i].type);
1954     job_stats_submit(domain, &params[i]);
1955   }
1956
1957   virTypedParamsFree(params, nparams);
1958   return ret;
1959 }
1960 #endif /* HAVE_JOB_STATS */
1961
1962 static int get_domain_metrics(domain_t *domain) {
1963   if (!domain || !domain->ptr) {
1964     ERROR(PLUGIN_NAME " plugin: get_domain_metrics: NULL pointer");
1965     return -1;
1966   }
1967
1968   virDomainInfo info;
1969   int status = virDomainGetInfo(domain->ptr, &info);
1970   if (status != 0) {
1971     ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
1972           status);
1973     return -1;
1974   }
1975
1976   if (extra_stats & ex_stats_domain_state) {
1977 #ifdef HAVE_DOM_REASON
1978     /* At this point we already know domain's state from virDomainGetInfo call,
1979      * however it doesn't provide a reason for entering particular state.
1980      * We need to get it from virDomainGetState.
1981      */
1982     GET_STATS(get_domain_state, "domain reason", domain->ptr);
1983 #endif
1984   }
1985
1986   /* Gather remaining stats only for running domains */
1987   if (info.state != VIR_DOMAIN_RUNNING)
1988     return 0;
1989
1990 #ifdef HAVE_CPU_STATS
1991   if (extra_stats & ex_stats_pcpu)
1992     get_pcpu_stats(domain->ptr);
1993 #endif
1994
1995   cpu_submit(domain, info.cpuTime);
1996
1997   memory_submit(domain->ptr, (gauge_t)info.memory * 1024);
1998
1999   GET_STATS(get_vcpu_stats, "vcpu stats", domain->ptr, info.nrVirtCpu);
2000   GET_STATS(get_memory_stats, "memory stats", domain->ptr);
2001
2002 #ifdef HAVE_PERF_STATS
2003   if (extra_stats & ex_stats_perf)
2004     GET_STATS(get_perf_events, "performance monitoring events", domain->ptr);
2005 #endif
2006
2007 #ifdef HAVE_FS_INFO
2008   if (extra_stats & ex_stats_fs_info)
2009     GET_STATS(get_fs_info, "file system info", domain->ptr);
2010 #endif
2011
2012 #ifdef HAVE_DISK_ERR
2013   if (extra_stats & ex_stats_disk_err)
2014     GET_STATS(get_disk_err, "disk errors", domain->ptr);
2015 #endif
2016
2017 #ifdef HAVE_JOB_STATS
2018   if (extra_stats &
2019       (ex_stats_job_stats_completed | ex_stats_job_stats_background))
2020     GET_STATS(get_job_stats, "job stats", domain->ptr);
2021 #endif
2022
2023   /* Update cached virDomainInfo. It has to be done after cpu_submit */
2024   memcpy(&domain->info, &info, sizeof(domain->info));
2025
2026   return 0;
2027 }
2028
2029 static int get_if_dev_stats(struct interface_device *if_dev) {
2030   virDomainInterfaceStatsStruct stats = {0};
2031   char *display_name = NULL;
2032
2033   if (!if_dev) {
2034     ERROR(PLUGIN_NAME " plugin: get_if_dev_stats: NULL pointer");
2035     return -1;
2036   }
2037
2038   switch (interface_format) {
2039   case if_address:
2040     display_name = if_dev->address;
2041     break;
2042   case if_number:
2043     display_name = if_dev->number;
2044     break;
2045   case if_name:
2046   default:
2047     display_name = if_dev->path;
2048   }
2049
2050   if (virDomainInterfaceStats(if_dev->dom, if_dev->path, &stats,
2051                               sizeof(stats)) != 0) {
2052     ERROR(PLUGIN_NAME " plugin: virDomainInterfaceStats failed");
2053     return -1;
2054   }
2055
2056   if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
2057     submit_derive2("if_octets", (derive_t)stats.rx_bytes,
2058                    (derive_t)stats.tx_bytes, if_dev->dom, display_name);
2059
2060   if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
2061     submit_derive2("if_packets", (derive_t)stats.rx_packets,
2062                    (derive_t)stats.tx_packets, if_dev->dom, display_name);
2063
2064   if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
2065     submit_derive2("if_errors", (derive_t)stats.rx_errs,
2066                    (derive_t)stats.tx_errs, if_dev->dom, display_name);
2067
2068   if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
2069     submit_derive2("if_dropped", (derive_t)stats.rx_drop,
2070                    (derive_t)stats.tx_drop, if_dev->dom, display_name);
2071   return 0;
2072 }
2073
2074 static int domain_lifecycle_event_cb(__attribute__((unused)) virConnectPtr con_,
2075                                      virDomainPtr dom, int event, int detail,
2076                                      __attribute__((unused)) void *opaque) {
2077   int domain_state = map_domain_event_to_state(event);
2078   int domain_reason = 0; /* 0 means UNKNOWN reason for any state */
2079 #ifdef HAVE_DOM_REASON
2080   domain_reason = map_domain_event_detail_to_reason(event, detail);
2081 #endif
2082   domain_state_submit_notif(dom, domain_state, domain_reason);
2083
2084   return 0;
2085 }
2086
2087 static int register_event_impl(void) {
2088   if (virEventRegisterDefaultImpl() < 0) {
2089     virErrorPtr err = virGetLastError();
2090     ERROR(PLUGIN_NAME
2091           " plugin: error while event implementation registering: %s",
2092           err && err->message ? err->message : "Unknown error");
2093     return -1;
2094   }
2095
2096   return 0;
2097 }
2098
2099 static void virt_notif_thread_set_active(virt_notif_thread_t *thread_data,
2100                                          const bool active) {
2101   assert(thread_data != NULL);
2102   pthread_mutex_lock(&thread_data->active_mutex);
2103   thread_data->is_active = active;
2104   pthread_mutex_unlock(&thread_data->active_mutex);
2105 }
2106
2107 static bool virt_notif_thread_is_active(virt_notif_thread_t *thread_data) {
2108   bool active = false;
2109
2110   assert(thread_data != NULL);
2111   pthread_mutex_lock(&thread_data->active_mutex);
2112   active = thread_data->is_active;
2113   pthread_mutex_unlock(&thread_data->active_mutex);
2114
2115   return active;
2116 }
2117
2118 /* worker function running default event implementation */
2119 static void *event_loop_worker(void *arg) {
2120   virt_notif_thread_t *thread_data = (virt_notif_thread_t *)arg;
2121
2122   while (virt_notif_thread_is_active(thread_data)) {
2123     if (virEventRunDefaultImpl() < 0) {
2124       virErrorPtr err = virGetLastError();
2125       ERROR(PLUGIN_NAME " plugin: failed to run event loop: %s\n",
2126             err && err->message ? err->message : "Unknown error");
2127     }
2128   }
2129
2130   return NULL;
2131 }
2132
2133 static int virt_notif_thread_init(virt_notif_thread_t *thread_data) {
2134   int ret;
2135
2136   assert(thread_data != NULL);
2137   ret = pthread_mutex_init(&thread_data->active_mutex, NULL);
2138   if (ret != 0) {
2139     ERROR(PLUGIN_NAME " plugin: Failed to initialize mutex, err %u", ret);
2140     return ret;
2141   }
2142
2143   /**
2144    * '0' and positive integers are meaningful ID's, therefore setting
2145    * domain_event_cb_id to '-1'
2146    */
2147   thread_data->domain_event_cb_id = -1;
2148   pthread_mutex_lock(&thread_data->active_mutex);
2149   thread_data->is_active = false;
2150   pthread_mutex_unlock(&thread_data->active_mutex);
2151
2152   return 0;
2153 }
2154
2155 /* register domain event callback and start event loop thread */
2156 static int start_event_loop(virt_notif_thread_t *thread_data) {
2157   assert(thread_data != NULL);
2158   thread_data->domain_event_cb_id = virConnectDomainEventRegisterAny(
2159       conn, NULL, VIR_DOMAIN_EVENT_ID_LIFECYCLE,
2160       VIR_DOMAIN_EVENT_CALLBACK(domain_lifecycle_event_cb), NULL, NULL);
2161   if (thread_data->domain_event_cb_id == -1) {
2162     ERROR(PLUGIN_NAME " plugin: error while callback registering");
2163     return -1;
2164   }
2165
2166   virt_notif_thread_set_active(thread_data, 1);
2167   if (pthread_create(&thread_data->event_loop_tid, NULL, event_loop_worker,
2168                      thread_data)) {
2169     ERROR(PLUGIN_NAME " plugin: failed event loop thread creation");
2170     virConnectDomainEventDeregisterAny(conn, thread_data->domain_event_cb_id);
2171     return -1;
2172   }
2173
2174   return 0;
2175 }
2176
2177 /* stop event loop thread and deregister callback */
2178 static void stop_event_loop(virt_notif_thread_t *thread_data) {
2179   /* stopping loop and de-registering event handler*/
2180   virt_notif_thread_set_active(thread_data, 0);
2181   if (conn != NULL && thread_data->domain_event_cb_id != -1)
2182     virConnectDomainEventDeregisterAny(conn, thread_data->domain_event_cb_id);
2183
2184   if (pthread_join(notif_thread.event_loop_tid, NULL) != 0)
2185     ERROR(PLUGIN_NAME " plugin: stopping notification thread failed");
2186 }
2187
2188 static int persistent_domains_state_notification(void) {
2189   int status = 0;
2190   int n;
2191 #ifdef HAVE_LIST_ALL_DOMAINS
2192   virDomainPtr *domains = NULL;
2193   n = virConnectListAllDomains(conn, &domains,
2194                                VIR_CONNECT_LIST_DOMAINS_PERSISTENT);
2195   if (n < 0) {
2196     VIRT_ERROR(conn, "reading list of persistent domains");
2197     status = -1;
2198   } else {
2199     DEBUG(PLUGIN_NAME " plugin: getting state of %i persistent domains", n);
2200     /* Fetch each persistent domain's state and notify it */
2201     int n_notified = n;
2202     for (int i = 0; i < n; ++i) {
2203       status = get_domain_state_notify(domains[i]);
2204       if (status != 0) {
2205         n_notified--;
2206         ERROR(PLUGIN_NAME " plugin: could not notify state of domain %s",
2207               virDomainGetName(domains[i]));
2208       }
2209       virDomainFree(domains[i]);
2210     }
2211
2212     sfree(domains);
2213     DEBUG(PLUGIN_NAME " plugin: notified state of %i persistent domains",
2214           n_notified);
2215   }
2216 #else
2217   n = virConnectNumOfDomains(conn);
2218   if (n > 0) {
2219     int *domids;
2220     /* Get list of domains. */
2221     domids = calloc(n, sizeof(*domids));
2222     if (domids == NULL) {
2223       ERROR(PLUGIN_NAME " plugin: calloc failed.");
2224       return -1;
2225     }
2226     n = virConnectListDomains(conn, domids, n);
2227     if (n < 0) {
2228       VIRT_ERROR(conn, "reading list of domains");
2229       sfree(domids);
2230       return -1;
2231     }
2232     /* Fetch info of each active domain and notify it */
2233     for (int i = 0; i < n; ++i) {
2234       virDomainInfo info;
2235       virDomainPtr dom = NULL;
2236       dom = virDomainLookupByID(conn, domids[i]);
2237       if (dom == NULL) {
2238         VIRT_ERROR(conn, "virDomainLookupByID");
2239         /* Could be that the domain went away -- ignore it anyway. */
2240         continue;
2241       }
2242       status = virDomainGetInfo(dom, &info);
2243       if (status == 0)
2244         /* virDomainGetState is not available. Submit 0, which corresponds to
2245          * unknown reason. */
2246         domain_state_submit_notif(dom, info.state, 0);
2247       else
2248         ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
2249               status);
2250
2251       virDomainFree(dom);
2252     }
2253     sfree(domids);
2254   }
2255 #endif
2256
2257   return status;
2258 }
2259
2260 static int lv_read(user_data_t *ud) {
2261   time_t t;
2262   struct lv_read_instance *inst = NULL;
2263   struct lv_read_state *state = NULL;
2264
2265   if (ud->data == NULL) {
2266     ERROR(PLUGIN_NAME " plugin: NULL userdata");
2267     return -1;
2268   }
2269
2270   inst = ud->data;
2271   state = &inst->read_state;
2272
2273   bool reconnect = conn == NULL ? true : false;
2274   /* event implementation must be registered before connection is opened */
2275   if (inst->id == 0) {
2276     if (!persistent_notification && reconnect)
2277       if (register_event_impl() != 0)
2278         return -1;
2279
2280     if (lv_connect() < 0)
2281       return -1;
2282
2283     if (!persistent_notification && reconnect && conn != NULL)
2284       if (start_event_loop(&notif_thread) != 0)
2285         return -1;
2286   }
2287
2288   time(&t);
2289
2290   /* Need to refresh domain or device lists? */
2291   if ((last_refresh == (time_t)0) ||
2292       ((interval > 0) && ((last_refresh + interval) <= t))) {
2293     if (refresh_lists(inst) != 0) {
2294       if (inst->id == 0) {
2295         if (!persistent_notification)
2296           stop_event_loop(&notif_thread);
2297         lv_disconnect();
2298       }
2299       return -1;
2300     }
2301     last_refresh = t;
2302   }
2303
2304   /* persistent domains state notifications are handled by instance 0 */
2305   if (inst->id == 0 && persistent_notification) {
2306     int status = persistent_domains_state_notification();
2307     if (status != 0)
2308       DEBUG(PLUGIN_NAME " plugin: persistent_domains_state_notifications "
2309                         "returned with status %i",
2310             status);
2311   }
2312
2313 #if COLLECT_DEBUG
2314   for (int i = 0; i < state->nr_domains; ++i)
2315     DEBUG(PLUGIN_NAME " plugin: domain %s",
2316           virDomainGetName(state->domains[i].ptr));
2317   for (int i = 0; i < state->nr_block_devices; ++i)
2318     DEBUG(PLUGIN_NAME " plugin: block device %d %s:%s", i,
2319           virDomainGetName(state->block_devices[i].dom),
2320           state->block_devices[i].path);
2321   for (int i = 0; i < state->nr_interface_devices; ++i)
2322     DEBUG(PLUGIN_NAME " plugin: interface device %d %s:%s", i,
2323           virDomainGetName(state->interface_devices[i].dom),
2324           state->interface_devices[i].path);
2325 #endif
2326
2327   /* Get domains' metrics */
2328   for (int i = 0; i < state->nr_domains; ++i) {
2329     domain_t *dom = &state->domains[i];
2330     int status = 0;
2331     if (dom->active)
2332       status = get_domain_metrics(dom);
2333 #ifdef HAVE_DOM_REASON
2334     else
2335       status = get_domain_state(dom->ptr);
2336 #endif
2337
2338     if (status != 0)
2339       ERROR(PLUGIN_NAME " plugin: failed to get metrics for domain=%s",
2340             virDomainGetName(dom->ptr));
2341   }
2342
2343   /* Get block device stats for each domain. */
2344   for (int i = 0; i < state->nr_block_devices; ++i) {
2345     int status = get_block_device_stats(&state->block_devices[i]);
2346     if (status != 0)
2347       ERROR(PLUGIN_NAME
2348             " plugin: failed to get stats for block device (%s) in domain %s",
2349             state->block_devices[i].path,
2350             virDomainGetName(state->block_devices[i].dom));
2351   }
2352
2353   /* Get interface stats for each domain. */
2354   for (int i = 0; i < state->nr_interface_devices; ++i) {
2355     int status = get_if_dev_stats(&state->interface_devices[i]);
2356     if (status != 0)
2357       ERROR(
2358           PLUGIN_NAME
2359           " plugin: failed to get interface stats for device (%s) in domain %s",
2360           state->interface_devices[i].path,
2361           virDomainGetName(state->interface_devices[i].dom));
2362   }
2363
2364   return 0;
2365 }
2366
2367 static int lv_init_instance(size_t i, plugin_read_cb callback) {
2368   struct lv_user_data *lv_ud = &(lv_read_user_data[i]);
2369   struct lv_read_instance *inst = &(lv_ud->inst);
2370
2371   memset(lv_ud, 0, sizeof(*lv_ud));
2372
2373   snprintf(inst->tag, sizeof(inst->tag), "%s-%" PRIsz, PLUGIN_NAME, i);
2374   inst->id = i;
2375
2376   user_data_t *ud = &(lv_ud->ud);
2377   ud->data = inst;
2378   ud->free_func = NULL;
2379
2380   INFO(PLUGIN_NAME " plugin: reader %s initialized", inst->tag);
2381
2382   return plugin_register_complex_read(NULL, inst->tag, callback, 0, ud);
2383 }
2384
2385 static void lv_clean_read_state(struct lv_read_state *state) {
2386   free_block_devices(state);
2387   free_interface_devices(state);
2388   free_domains(state);
2389 }
2390
2391 static void lv_fini_instance(size_t i) {
2392   struct lv_read_instance *inst = &(lv_read_user_data[i].inst);
2393   struct lv_read_state *state = &(inst->read_state);
2394
2395   lv_clean_read_state(state);
2396
2397   INFO(PLUGIN_NAME " plugin: reader %s finalized", inst->tag);
2398 }
2399
2400 static int lv_init(void) {
2401   if (virInitialize() != 0)
2402     return -1;
2403
2404   /* Init ignorelists if there was no explicit configuration */
2405   if (lv_init_ignorelists() != 0)
2406     return -1;
2407
2408   /* event implementation must be registered before connection is opened */
2409   if (!persistent_notification)
2410     if (register_event_impl() != 0)
2411       return -1;
2412
2413   if (lv_connect() != 0)
2414     return -1;
2415
2416   DEBUG(PLUGIN_NAME " plugin: starting event loop");
2417
2418   if (!persistent_notification) {
2419     virt_notif_thread_init(&notif_thread);
2420     if (start_event_loop(&notif_thread) != 0)
2421       return -1;
2422   }
2423
2424   DEBUG(PLUGIN_NAME " plugin: starting %i instances", nr_instances);
2425
2426   for (int i = 0; i < nr_instances; ++i)
2427     if (lv_init_instance(i, lv_read) != 0)
2428       return -1;
2429
2430   return 0;
2431 }
2432
2433 /*
2434  * returns 0 on success and <0 on error
2435  */
2436 static int lv_domain_get_tag(xmlXPathContextPtr xpath_ctx, const char *dom_name,
2437                              char *dom_tag) {
2438   char xpath_str[BUFFER_MAX_LEN] = {'\0'};
2439   xmlXPathObjectPtr xpath_obj = NULL;
2440   xmlNodePtr xml_node = NULL;
2441   int ret = -1;
2442   int err;
2443
2444   err = xmlXPathRegisterNs(xpath_ctx,
2445                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX,
2446                            (const xmlChar *)METADATA_VM_PARTITION_URI);
2447   if (err) {
2448     ERROR(PLUGIN_NAME " plugin: xmlXpathRegisterNs(%s, %s) failed on domain %s",
2449           METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_URI, dom_name);
2450     goto done;
2451   }
2452
2453   snprintf(xpath_str, sizeof(xpath_str), "/domain/metadata/%s:%s/text()",
2454            METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_ELEMENT);
2455   xpath_obj = xmlXPathEvalExpression((xmlChar *)xpath_str, xpath_ctx);
2456   if (xpath_obj == NULL) {
2457     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed on domain %s",
2458           xpath_str, dom_name);
2459     goto done;
2460   }
2461
2462   if (xpath_obj->type != XPATH_NODESET) {
2463     ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
2464                       "(wanted %d) on domain %s",
2465           xpath_str, xpath_obj->type, XPATH_NODESET, dom_name);
2466     goto done;
2467   }
2468
2469   /*
2470    * from now on there is no real error, it's ok if a domain
2471    * doesn't have the metadata partition tag.
2472    */
2473   ret = 0;
2474   if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
2475     DEBUG(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
2476                       "expected=1 on domain %s",
2477           xpath_str,
2478           (xpath_obj->nodesetval == NULL) ? 0 : xpath_obj->nodesetval->nodeNr,
2479           dom_name);
2480   } else {
2481     xml_node = xpath_obj->nodesetval->nodeTab[0];
2482     sstrncpy(dom_tag, (const char *)xml_node->content, PARTITION_TAG_MAX_LEN);
2483   }
2484
2485 done:
2486   /* deregister to clean up */
2487   err = xmlXPathRegisterNs(xpath_ctx,
2488                            (const xmlChar *)METADATA_VM_PARTITION_PREFIX, NULL);
2489   if (err) {
2490     /* we can't really recover here */
2491     ERROR(PLUGIN_NAME
2492           " plugin: deregistration of namespace %s failed for domain %s",
2493           METADATA_VM_PARTITION_PREFIX, dom_name);
2494   }
2495   if (xpath_obj)
2496     xmlXPathFreeObject(xpath_obj);
2497
2498   return ret;
2499 }
2500
2501 static int is_known_tag(const char *dom_tag) {
2502   for (int i = 0; i < nr_instances; ++i)
2503     if (!strcmp(dom_tag, lv_read_user_data[i].inst.tag))
2504       return 1;
2505   return 0;
2506 }
2507
2508 static int lv_instance_include_domain(struct lv_read_instance *inst,
2509                                       const char *dom_name,
2510                                       const char *dom_tag) {
2511   if ((dom_tag[0] != '\0') && (strcmp(dom_tag, inst->tag) == 0))
2512     return 1;
2513
2514   /* instance#0 will always be there, so it is in charge of extra duties */
2515   if (inst->id == 0) {
2516     if (dom_tag[0] == '\0' || !is_known_tag(dom_tag)) {
2517       DEBUG(PLUGIN_NAME " plugin#%s: refreshing domain %s "
2518                         "with unknown tag '%s'",
2519             inst->tag, dom_name, dom_tag);
2520       return 1;
2521     }
2522   }
2523
2524   return 0;
2525 }
2526
2527 static void lv_add_block_devices(struct lv_read_state *state, virDomainPtr dom,
2528                                  const char *domname,
2529                                  xmlXPathContextPtr xpath_ctx) {
2530   xmlXPathObjectPtr xpath_obj =
2531       xmlXPathEval((const xmlChar *)"/domain/devices/disk", xpath_ctx);
2532
2533   if (xpath_obj == NULL) {
2534     DEBUG(PLUGIN_NAME " plugin: no disk xpath-object found for domain %s",
2535           domname);
2536     return;
2537   }
2538
2539   if (xpath_obj->type != XPATH_NODESET || xpath_obj->nodesetval == NULL) {
2540     DEBUG(PLUGIN_NAME " plugin: no disk node found for domain %s", domname);
2541     goto cleanup;
2542   }
2543
2544   xmlNodeSetPtr xml_block_devices = xpath_obj->nodesetval;
2545   for (int i = 0; i < xml_block_devices->nodeNr; ++i) {
2546     xmlNodePtr xml_device = xpath_obj->nodesetval->nodeTab[i];
2547     char *path_str = NULL;
2548     char *source_str = NULL;
2549
2550     if (!xml_device)
2551       continue;
2552
2553     /* Fetching path and source for block device */
2554     for (xmlNodePtr child = xml_device->children; child; child = child->next) {
2555       if (child->type != XML_ELEMENT_NODE)
2556         continue;
2557
2558       /* we are interested only in either "target" or "source" elements */
2559       if (xmlStrEqual(child->name, (const xmlChar *)"target"))
2560         path_str = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2561       else if (xmlStrEqual(child->name, (const xmlChar *)"source")) {
2562         /* name of the source is located in "dev" or "file" element (it depends
2563          * on type of source). Trying "dev" at first*/
2564         source_str = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2565         if (!source_str)
2566           source_str = (char *)xmlGetProp(child, (const xmlChar *)"file");
2567       }
2568       /* ignoring any other element*/
2569     }
2570
2571     /* source_str will be interpreted as a device path if blockdevice_format
2572      *  param is set to 'source'. */
2573     const char *device_path =
2574         (blockdevice_format == source) ? source_str : path_str;
2575
2576     if (!device_path) {
2577       /* no path found and we can't add block_device without it */
2578       WARNING(PLUGIN_NAME " plugin: could not generate device path for disk in "
2579                           "domain %s - disk device will be ignored in reports",
2580               domname);
2581       goto cont;
2582     }
2583
2584     if (ignore_device_match(il_block_devices, domname, device_path) == 0) {
2585       /* we only have to store information whether 'source' exists or not */
2586       bool has_source = (source_str != NULL) ? true : false;
2587
2588       add_block_device(state, dom, device_path, has_source);
2589     }
2590
2591   cont:
2592     if (path_str)
2593       xmlFree(path_str);
2594
2595     if (source_str)
2596       xmlFree(source_str);
2597   }
2598
2599 cleanup:
2600   xmlXPathFreeObject(xpath_obj);
2601 }
2602
2603 static void lv_add_network_interfaces(struct lv_read_state *state,
2604                                       virDomainPtr dom, const char *domname,
2605                                       xmlXPathContextPtr xpath_ctx) {
2606   xmlXPathObjectPtr xpath_obj = xmlXPathEval(
2607       (xmlChar *)"/domain/devices/interface[target[@dev]]", xpath_ctx);
2608
2609   if (xpath_obj == NULL)
2610     return;
2611
2612   if (xpath_obj->type != XPATH_NODESET || xpath_obj->nodesetval == NULL) {
2613     xmlXPathFreeObject(xpath_obj);
2614     return;
2615   }
2616
2617   xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
2618
2619   for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
2620     char *path = NULL;
2621     char *address = NULL;
2622     const int itf_number = j + 1;
2623
2624     xmlNodePtr xml_interface = xml_interfaces->nodeTab[j];
2625     if (!xml_interface)
2626       continue;
2627
2628     for (xmlNodePtr child = xml_interface->children; child;
2629          child = child->next) {
2630       if (child->type != XML_ELEMENT_NODE)
2631         continue;
2632
2633       if (xmlStrEqual(child->name, (const xmlChar *)"target")) {
2634         path = (char *)xmlGetProp(child, (const xmlChar *)"dev");
2635         if (!path)
2636           continue;
2637       } else if (xmlStrEqual(child->name, (const xmlChar *)"mac")) {
2638         address = (char *)xmlGetProp(child, (const xmlChar *)"address");
2639         if (!address)
2640           continue;
2641       }
2642     }
2643
2644     bool device_ignored = false;
2645     switch (interface_format) {
2646     case if_name:
2647       if (ignore_device_match(il_interface_devices, domname, path) != 0)
2648         device_ignored = true;
2649       break;
2650     case if_address:
2651       if (ignore_device_match(il_interface_devices, domname, address) != 0)
2652         device_ignored = true;
2653       break;
2654     case if_number: {
2655       char number_string[4];
2656       snprintf(number_string, sizeof(number_string), "%d", itf_number);
2657       if (ignore_device_match(il_interface_devices, domname, number_string) !=
2658           0)
2659         device_ignored = true;
2660     } break;
2661     default:
2662       ERROR(PLUGIN_NAME " plugin: Unknown interface_format option: %d",
2663             interface_format);
2664     }
2665
2666     if (!device_ignored)
2667       add_interface_device(state, dom, path, address, itf_number);
2668
2669     if (path)
2670       xmlFree(path);
2671     if (address)
2672       xmlFree(address);
2673   }
2674   xmlXPathFreeObject(xpath_obj);
2675 }
2676
2677 static bool is_domain_ignored(virDomainPtr dom) {
2678   const char *domname = virDomainGetName(dom);
2679
2680   if (domname == NULL) {
2681     VIRT_ERROR(conn, "virDomainGetName failed, ignoring domain");
2682     return true;
2683   }
2684
2685   if (ignorelist_match(il_domains, domname) != 0) {
2686     DEBUG(PLUGIN_NAME
2687           " plugin: ignoring domain '%s' because of ignorelist option",
2688           domname);
2689     return true;
2690   }
2691
2692   return false;
2693 }
2694
2695 static int refresh_lists(struct lv_read_instance *inst) {
2696   struct lv_read_state *state = &inst->read_state;
2697   int n;
2698
2699 #ifndef HAVE_LIST_ALL_DOMAINS
2700   n = virConnectNumOfDomains(conn);
2701   if (n < 0) {
2702     VIRT_ERROR(conn, "reading number of domains");
2703     return -1;
2704   }
2705 #endif
2706
2707   lv_clean_read_state(state);
2708
2709 #ifndef HAVE_LIST_ALL_DOMAINS
2710   if (n == 0)
2711     goto end;
2712 #endif
2713
2714 #ifdef HAVE_LIST_ALL_DOMAINS
2715   virDomainPtr *domains, *domains_inactive;
2716   int m = virConnectListAllDomains(conn, &domains_inactive,
2717                                    VIR_CONNECT_LIST_DOMAINS_INACTIVE);
2718   n = virConnectListAllDomains(conn, &domains, VIR_CONNECT_LIST_DOMAINS_ACTIVE);
2719 #else
2720   /* Get list of domains. */
2721   int *domids = calloc(n, sizeof(*domids));
2722   if (domids == NULL) {
2723     ERROR(PLUGIN_NAME " plugin: calloc failed.");
2724     return -1;
2725   }
2726
2727   n = virConnectListDomains(conn, domids, n);
2728 #endif
2729
2730   if (n < 0) {
2731     VIRT_ERROR(conn, "reading list of domains");
2732 #ifndef HAVE_LIST_ALL_DOMAINS
2733     sfree(domids);
2734 #else
2735     for (int i = 0; i < m; ++i)
2736       virDomainFree(domains_inactive[i]);
2737     sfree(domains_inactive);
2738 #endif
2739     return -1;
2740   }
2741
2742 #ifdef HAVE_LIST_ALL_DOMAINS
2743   for (int i = 0; i < m; ++i)
2744     if (is_domain_ignored(domains_inactive[i]) ||
2745         add_domain(state, domains_inactive[i], 0) < 0) {
2746       /* domain ignored or failed during adding to domains list*/
2747       virDomainFree(domains_inactive[i]);
2748       domains_inactive[i] = NULL;
2749       continue;
2750     }
2751 #endif
2752
2753   /* Fetch each domain and add it to the list, unless ignore. */
2754   for (int i = 0; i < n; ++i) {
2755
2756 #ifdef HAVE_LIST_ALL_DOMAINS
2757     virDomainPtr dom = domains[i];
2758 #else
2759     virDomainPtr dom = virDomainLookupByID(conn, domids[i]);
2760     if (dom == NULL) {
2761       VIRT_ERROR(conn, "virDomainLookupByID");
2762       /* Could be that the domain went away -- ignore it anyway. */
2763       continue;
2764     }
2765 #endif
2766
2767     if (is_domain_ignored(dom) || add_domain(state, dom, 1) < 0) {
2768       /*
2769        * domain ignored or failed during adding to domains list
2770        *
2771        * When domain is already tracked, then there is
2772        * no problem with memory handling (will be freed
2773        * with the rest of domains cached data)
2774        * But in case of error like this (error occurred
2775        * before adding domain to track) we have to take
2776        * care it ourselves and call virDomainFree
2777        */
2778       virDomainFree(dom);
2779       continue;
2780     }
2781
2782     const char *domname = virDomainGetName(dom);
2783     if (domname == NULL) {
2784       VIRT_ERROR(conn, "virDomainGetName");
2785       continue;
2786     }
2787
2788     virDomainInfo info;
2789     int status = virDomainGetInfo(dom, &info);
2790     if (status != 0) {
2791       ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
2792             status);
2793       continue;
2794     }
2795
2796     if (info.state != VIR_DOMAIN_RUNNING) {
2797       DEBUG(PLUGIN_NAME " plugin: skipping inactive domain %s", domname);
2798       continue;
2799     }
2800
2801     /* Get a list of devices for this domain. */
2802     xmlDocPtr xml_doc = NULL;
2803     xmlXPathContextPtr xpath_ctx = NULL;
2804
2805     char *xml = virDomainGetXMLDesc(dom, 0);
2806     if (!xml) {
2807       VIRT_ERROR(conn, "virDomainGetXMLDesc");
2808       goto cont;
2809     }
2810
2811     /* Yuck, XML.  Parse out the devices. */
2812     xml_doc = xmlReadDoc((xmlChar *)xml, NULL, NULL, XML_PARSE_NONET);
2813     if (xml_doc == NULL) {
2814       VIRT_ERROR(conn, "xmlReadDoc");
2815       goto cont;
2816     }
2817
2818     xpath_ctx = xmlXPathNewContext(xml_doc);
2819
2820     char tag[PARTITION_TAG_MAX_LEN] = {'\0'};
2821     if (lv_domain_get_tag(xpath_ctx, domname, tag) < 0) {
2822       ERROR(PLUGIN_NAME " plugin: lv_domain_get_tag failed.");
2823       goto cont;
2824     }
2825
2826     if (!lv_instance_include_domain(inst, domname, tag))
2827       goto cont;
2828
2829     /* Block devices. */
2830     if (report_block_devices)
2831       lv_add_block_devices(state, dom, domname, xpath_ctx);
2832
2833     /* Network interfaces. */
2834     if (report_network_interfaces)
2835       lv_add_network_interfaces(state, dom, domname, xpath_ctx);
2836
2837   cont:
2838     if (xpath_ctx)
2839       xmlXPathFreeContext(xpath_ctx);
2840     if (xml_doc)
2841       xmlFreeDoc(xml_doc);
2842     sfree(xml);
2843   }
2844
2845 #ifdef HAVE_LIST_ALL_DOMAINS
2846   /* NOTE: domains_active and domains_inactive data will be cleared during
2847      refresh of all domains (inside lv_clean_read_state function) so we need
2848      to free here only allocated arrays */
2849   sfree(domains);
2850   sfree(domains_inactive);
2851 #else
2852   sfree(domids);
2853
2854 end:
2855 #endif
2856
2857   DEBUG(PLUGIN_NAME " plugin#%s: refreshing"
2858                     " domains=%i block_devices=%i iface_devices=%i",
2859         inst->tag, state->nr_domains, state->nr_block_devices,
2860         state->nr_interface_devices);
2861
2862   return 0;
2863 }
2864
2865 static void free_domains(struct lv_read_state *state) {
2866   if (state->domains) {
2867     for (int i = 0; i < state->nr_domains; ++i)
2868       virDomainFree(state->domains[i].ptr);
2869     sfree(state->domains);
2870   }
2871   state->domains = NULL;
2872   state->nr_domains = 0;
2873 }
2874
2875 static int add_domain(struct lv_read_state *state, virDomainPtr dom,
2876                       bool active) {
2877   int new_size = sizeof(state->domains[0]) * (state->nr_domains + 1);
2878
2879   domain_t *new_ptr = realloc(state->domains, new_size);
2880   if (new_ptr == NULL) {
2881     ERROR(PLUGIN_NAME " plugin: realloc failed in add_domain()");
2882     return -1;
2883   }
2884
2885   state->domains = new_ptr;
2886   state->domains[state->nr_domains].ptr = dom;
2887   state->domains[state->nr_domains].active = active;
2888   memset(&state->domains[state->nr_domains].info, 0,
2889          sizeof(state->domains[state->nr_domains].info));
2890
2891   return state->nr_domains++;
2892 }
2893
2894 static void free_block_devices(struct lv_read_state *state) {
2895   if (state->block_devices) {
2896     for (int i = 0; i < state->nr_block_devices; ++i)
2897       sfree(state->block_devices[i].path);
2898     sfree(state->block_devices);
2899   }
2900   state->block_devices = NULL;
2901   state->nr_block_devices = 0;
2902 }
2903
2904 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
2905                             const char *path, bool has_source) {
2906
2907   char *path_copy = strdup(path);
2908   if (!path_copy)
2909     return -1;
2910
2911   int new_size =
2912       sizeof(state->block_devices[0]) * (state->nr_block_devices + 1);
2913
2914   struct block_device *new_ptr = realloc(state->block_devices, new_size);
2915   if (new_ptr == NULL) {
2916     sfree(path_copy);
2917     return -1;
2918   }
2919   state->block_devices = new_ptr;
2920   state->block_devices[state->nr_block_devices].dom = dom;
2921   state->block_devices[state->nr_block_devices].path = path_copy;
2922   state->block_devices[state->nr_block_devices].has_source = has_source;
2923   return state->nr_block_devices++;
2924 }
2925
2926 static void free_interface_devices(struct lv_read_state *state) {
2927   if (state->interface_devices) {
2928     for (int i = 0; i < state->nr_interface_devices; ++i) {
2929       sfree(state->interface_devices[i].path);
2930       sfree(state->interface_devices[i].address);
2931       sfree(state->interface_devices[i].number);
2932     }
2933     sfree(state->interface_devices);
2934   }
2935   state->interface_devices = NULL;
2936   state->nr_interface_devices = 0;
2937 }
2938
2939 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
2940                                 const char *path, const char *address,
2941                                 unsigned int number) {
2942
2943   if ((path == NULL) || (address == NULL))
2944     return EINVAL;
2945
2946   char *path_copy = strdup(path);
2947   if (!path_copy)
2948     return -1;
2949
2950   char *address_copy = strdup(address);
2951   if (!address_copy) {
2952     sfree(path_copy);
2953     return -1;
2954   }
2955
2956   char number_string[21];
2957   snprintf(number_string, sizeof(number_string), "interface-%u", number);
2958   char *number_copy = strdup(number_string);
2959   if (!number_copy) {
2960     sfree(path_copy);
2961     sfree(address_copy);
2962     return -1;
2963   }
2964
2965   int new_size =
2966       sizeof(state->interface_devices[0]) * (state->nr_interface_devices + 1);
2967
2968   struct interface_device *new_ptr =
2969       realloc(state->interface_devices, new_size);
2970   if (new_ptr == NULL) {
2971     sfree(path_copy);
2972     sfree(address_copy);
2973     sfree(number_copy);
2974     return -1;
2975   }
2976
2977   state->interface_devices = new_ptr;
2978   state->interface_devices[state->nr_interface_devices].dom = dom;
2979   state->interface_devices[state->nr_interface_devices].path = path_copy;
2980   state->interface_devices[state->nr_interface_devices].address = address_copy;
2981   state->interface_devices[state->nr_interface_devices].number = number_copy;
2982   return state->nr_interface_devices++;
2983 }
2984
2985 static int ignore_device_match(ignorelist_t *il, const char *domname,
2986                                const char *devpath) {
2987   if ((domname == NULL) || (devpath == NULL))
2988     return 0;
2989
2990   size_t n = strlen(domname) + strlen(devpath) + 2;
2991   char *name = malloc(n);
2992   if (name == NULL) {
2993     ERROR(PLUGIN_NAME " plugin: malloc failed.");
2994     return 0;
2995   }
2996   snprintf(name, n, "%s:%s", domname, devpath);
2997   int r = ignorelist_match(il, name);
2998   sfree(name);
2999   return r;
3000 }
3001
3002 static int lv_shutdown(void) {
3003   for (int i = 0; i < nr_instances; ++i) {
3004     lv_fini_instance(i);
3005   }
3006
3007   DEBUG(PLUGIN_NAME " plugin: stopping event loop");
3008
3009   if (!persistent_notification)
3010     stop_event_loop(&notif_thread);
3011
3012   lv_disconnect();
3013
3014   ignorelist_free(il_domains);
3015   il_domains = NULL;
3016   ignorelist_free(il_block_devices);
3017   il_block_devices = NULL;
3018   ignorelist_free(il_interface_devices);
3019   il_interface_devices = NULL;
3020
3021   return 0;
3022 }
3023
3024 void module_register(void) {
3025   plugin_register_complex_config("virt", lv_config);
3026   plugin_register_init(PLUGIN_NAME, lv_init);
3027   plugin_register_shutdown(PLUGIN_NAME, lv_shutdown);
3028 }