1 /**
2 * collectd - src/lvm.c
3 * Copyright (C) 2013 Chad Malfait
4 * Copyright (C) 2014 Carnegie Mellon University
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Chad Malfait <malfaitc at yahoo.com>
21 * Benjamin Gilbert <bgilbert at cs.cmu.edu>
22 **/
24 #include <lvm2app.h>
26 #include "collectd.h"
28 #include "common.h"
29 #include "plugin.h"
31 #define NO_VALUE UINT64_MAX
32 #define PERCENT_SCALE_FACTOR 1e-8
34 static uint64_t get_lv_property_int(lv_t lv, char const *property)
35 {
36 lvm_property_value_t v;
38 v = lvm_lv_get_property(lv, property);
39 if (!v.is_valid || !v.is_integer)
40 return NO_VALUE;
41 /* May be NO_VALUE if @property does not apply to this LV */
42 return v.value.integer;
43 }
45 static char const *get_lv_property_string(lv_t lv, char const *property)
46 {
47 lvm_property_value_t v;
49 v = lvm_lv_get_property(lv, property);
50 if (!v.is_valid || !v.is_string)
51 return NULL;
52 return v.value.string;
53 }
55 static void lvm_submit (char const *plugin_instance, char const *type_instance,
56 uint64_t ivalue)
57 {
58 value_list_t vl = VALUE_LIST_INIT;
60 vl.values = &(value_t) { .gauge = (gauge_t) ivalue };
61 vl.values_len = 1;
63 sstrncpy(vl.host, hostname_g, sizeof (vl.host));
64 sstrncpy(vl.plugin, "lvm", sizeof (vl.plugin));
65 sstrncpy(vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
66 sstrncpy(vl.type, "df_complex", sizeof (vl.type));
67 sstrncpy(vl.type_instance, type_instance, sizeof (vl.type_instance));
69 plugin_dispatch_values (&vl);
70 }
72 static void report_lv_utilization(lv_t lv, char const *vg_name,
73 char const *lv_name, uint64_t lv_size,
74 char const *used_percent_property)
75 {
76 uint64_t used_percent_unscaled;
77 uint64_t used_bytes;
78 char plugin_instance[DATA_MAX_NAME_LEN];
80 used_percent_unscaled = get_lv_property_int(lv, used_percent_property);
81 if (used_percent_unscaled == NO_VALUE)
82 return;
83 used_bytes = lv_size * (used_percent_unscaled * PERCENT_SCALE_FACTOR);
85 ssnprintf(plugin_instance, sizeof(plugin_instance), "%s-%s",
86 vg_name, lv_name);
87 lvm_submit(plugin_instance, "used", used_bytes);
88 lvm_submit(plugin_instance, "free", lv_size - used_bytes);
89 }
91 static void report_thin_pool_utilization(lv_t lv, char const *vg_name,
92 uint64_t lv_size)
93 {
94 char const *data_lv;
95 char const *metadata_lv;
96 uint64_t metadata_size;
98 data_lv = get_lv_property_string(lv, "data_lv");
99 metadata_lv = get_lv_property_string(lv, "metadata_lv");
100 metadata_size = get_lv_property_int(lv, "lv_metadata_size");
101 if (data_lv == NULL || metadata_lv == NULL || metadata_size == NO_VALUE)
102 return;
104 report_lv_utilization(lv, vg_name, data_lv, lv_size, "data_percent");
105 report_lv_utilization(lv, vg_name, metadata_lv, metadata_size,
106 "metadata_percent");
107 }
109 static void vg_read(vg_t vg, char const *vg_name)
110 {
111 struct dm_list *lvs;
112 struct lvm_lv_list *lvl;
113 char const *name;
114 char const *attrs;
115 uint64_t size;
117 lvm_submit (vg_name, "free", lvm_vg_get_free_size(vg));
119 lvs = lvm_vg_list_lvs(vg);
120 if (!lvs) {
121 /* no VGs are defined, which is not an error per se */
122 return;
123 }
125 dm_list_iterate_items(lvl, lvs) {
126 name = lvm_lv_get_name(lvl->lv);
127 attrs = get_lv_property_string(lvl->lv, "lv_attr");
128 size = lvm_lv_get_size(lvl->lv);
129 if (name == NULL || attrs == NULL || size == NO_VALUE)
130 continue;
132 /* Condition on volume type. We want the reported sizes in the
133 volume group to sum to the size of the volume group, so we ignore
134 virtual volumes. */
135 switch (attrs[0]) {
136 case 's':
137 case 'S':
138 /* Snapshot. Also report used/free space. */
139 report_lv_utilization(lvl->lv, vg_name, name, size,
140 "data_percent");
141 break;
142 case 't':
143 /* Thin pool virtual volume. We report the underlying data
144 and metadata volumes, not this one. Report used/free
145 space, then ignore. */
146 report_thin_pool_utilization(lvl->lv, vg_name, size);
147 continue;
148 case 'v':
149 /* Virtual volume. Ignore. */
150 continue;
151 case 'V':
152 /* Thin volume or thin snapshot. Ignore. */
153 continue;
154 }
155 lvm_submit(vg_name, name, size);
156 }
157 }
159 static int lvm_read(void)
160 {
161 lvm_t lvm;
162 struct dm_list *vg_names;
163 struct lvm_str_list *name_list;
165 lvm = lvm_init(NULL);
166 if (!lvm) {
167 ERROR("lvm plugin: lvm_init failed.");
168 return (-1);
169 }
171 vg_names = lvm_list_vg_names(lvm);
172 if (!vg_names) {
173 ERROR("lvm plugin lvm_list_vg_name failed %s", lvm_errmsg(lvm));
174 lvm_quit(lvm);
175 return (-1);
176 }
178 dm_list_iterate_items(name_list, vg_names) {
179 vg_t vg;
181 vg = lvm_vg_open(lvm, name_list->str, "r", 0);
182 if (!vg) {
183 ERROR ("lvm plugin: lvm_vg_open (%s) failed: %s",
184 name_list->str, lvm_errmsg(lvm));
185 continue;
186 }
188 vg_read(vg, name_list->str);
189 lvm_vg_close(vg);
190 }
192 lvm_quit(lvm);
193 return (0);
194 } /*lvm_read */
196 void module_register(void)
197 {
198 plugin_register_read("lvm", lvm_read);
199 } /* void module_register */