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