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 backtick.net>
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 lvm_property_value_t v;
37 v = lvm_lv_get_property(lv, property);
38 if (!v.is_valid || !v.is_integer)
39 return NO_VALUE;
40 /* May be NO_VALUE if @property does not apply to this LV */
41 return v.value.integer;
42 }
44 static char const *get_lv_property_string(lv_t lv, char const *property) {
45 lvm_property_value_t v;
47 v = lvm_lv_get_property(lv, property);
48 if (!v.is_valid || !v.is_string)
49 return NULL;
50 return v.value.string;
51 }
53 static void lvm_submit(char const *plugin_instance, char const *type_instance,
54 uint64_t ivalue) {
55 value_list_t vl = VALUE_LIST_INIT;
57 vl.values = &(value_t){.gauge = (gauge_t)ivalue};
58 vl.values_len = 1;
60 sstrncpy(vl.plugin, "lvm", sizeof(vl.plugin));
61 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
62 sstrncpy(vl.type, "df_complex", sizeof(vl.type));
63 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
65 plugin_dispatch_values(&vl);
66 }
68 static void report_lv_utilization(lv_t lv, char const *vg_name,
69 char const *lv_name, uint64_t lv_size,
70 char const *used_percent_property) {
71 uint64_t used_percent_unscaled;
72 uint64_t used_bytes;
73 char plugin_instance[DATA_MAX_NAME_LEN];
75 used_percent_unscaled = get_lv_property_int(lv, used_percent_property);
76 if (used_percent_unscaled == NO_VALUE)
77 return;
78 used_bytes = lv_size * (used_percent_unscaled * PERCENT_SCALE_FACTOR);
80 ssnprintf(plugin_instance, sizeof(plugin_instance), "%s-%s", vg_name,
81 lv_name);
82 lvm_submit(plugin_instance, "used", used_bytes);
83 lvm_submit(plugin_instance, "free", lv_size - used_bytes);
84 }
86 static void report_thin_pool_utilization(lv_t lv, char const *vg_name,
87 uint64_t lv_size) {
88 char const *data_lv;
89 char const *metadata_lv;
90 uint64_t metadata_size;
92 data_lv = get_lv_property_string(lv, "data_lv");
93 metadata_lv = get_lv_property_string(lv, "metadata_lv");
94 metadata_size = get_lv_property_int(lv, "lv_metadata_size");
95 if (data_lv == NULL || metadata_lv == NULL || metadata_size == NO_VALUE)
96 return;
98 report_lv_utilization(lv, vg_name, data_lv, lv_size, "data_percent");
99 report_lv_utilization(lv, vg_name, metadata_lv, metadata_size,
100 "metadata_percent");
101 }
103 static void vg_read(vg_t vg, char const *vg_name) {
104 struct dm_list *lvs;
105 struct lvm_lv_list *lvl;
106 char const *name;
107 char const *attrs;
108 uint64_t size;
110 lvm_submit(vg_name, "free", lvm_vg_get_free_size(vg));
112 lvs = lvm_vg_list_lvs(vg);
113 if (!lvs) {
114 /* no VGs are defined, which is not an error per se */
115 return;
116 }
118 dm_list_iterate_items(lvl, lvs) {
119 name = lvm_lv_get_name(lvl->lv);
120 attrs = get_lv_property_string(lvl->lv, "lv_attr");
121 size = lvm_lv_get_size(lvl->lv);
122 if (name == NULL || attrs == NULL || size == NO_VALUE)
123 continue;
125 /* Condition on volume type. We want the reported sizes in the
126 volume group to sum to the size of the volume group, so we ignore
127 virtual volumes. */
128 switch (attrs[0]) {
129 case 's':
130 case 'S':
131 /* Snapshot. Also report used/free space. */
132 report_lv_utilization(lvl->lv, vg_name, name, size, "data_percent");
133 break;
134 case 't':
135 /* Thin pool virtual volume. We report the underlying data
136 and metadata volumes, not this one. Report used/free
137 space, then ignore. */
138 report_thin_pool_utilization(lvl->lv, vg_name, size);
139 continue;
140 case 'v':
141 /* Virtual volume. Ignore. */
142 continue;
143 case 'V':
144 /* Thin volume or thin snapshot. Ignore. */
145 continue;
146 }
147 lvm_submit(vg_name, name, size);
148 }
149 }
151 static int lvm_read(void) {
152 lvm_t lvm;
153 struct dm_list *vg_names;
154 struct lvm_str_list *name_list;
156 lvm = lvm_init(NULL);
157 if (!lvm) {
158 ERROR("lvm plugin: lvm_init failed.");
159 return (-1);
160 }
162 vg_names = lvm_list_vg_names(lvm);
163 if (!vg_names) {
164 ERROR("lvm plugin lvm_list_vg_name failed %s", lvm_errmsg(lvm));
165 lvm_quit(lvm);
166 return (-1);
167 }
169 dm_list_iterate_items(name_list, vg_names) {
170 vg_t vg;
172 vg = lvm_vg_open(lvm, name_list->str, "r", 0);
173 if (!vg) {
174 ERROR("lvm plugin: lvm_vg_open (%s) failed: %s", name_list->str,
175 lvm_errmsg(lvm));
176 continue;
177 }
179 vg_read(vg, name_list->str);
180 lvm_vg_close(vg);
181 }
183 lvm_quit(lvm);
184 return (0);
185 } /*lvm_read */
187 void module_register(void) {
188 plugin_register_read("lvm", lvm_read);
189 } /* void module_register */