1 /**
2 * collectd - src/df.c
3 * Copyright (C) 2005-2009 Florian octo Forster
4 * Copyright (C) 2009 Paul Sadauskas
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 * Florian octo Forster <octo at collectd.org>
21 * Paul Sadauskas <psadauskas at gmail.com>
22 **/
24 #include "collectd.h"
26 #include "common.h"
27 #include "plugin.h"
28 #include "configfile.h"
29 #include "utils_mount.h"
30 #include "utils_ignorelist.h"
32 #if HAVE_STATVFS
33 # if HAVE_SYS_STATVFS_H
34 # include <sys/statvfs.h>
35 # endif
36 # define STATANYFS statvfs
37 # define STATANYFS_STR "statvfs"
38 # define BLOCKSIZE(s) ((s).f_frsize ? (s).f_frsize : (s).f_bsize)
39 #elif HAVE_STATFS
40 # if HAVE_SYS_STATFS_H
41 # include <sys/statfs.h>
42 # endif
43 # define STATANYFS statfs
44 # define STATANYFS_STR "statfs"
45 # define BLOCKSIZE(s) (s).f_bsize
46 #else
47 # error "No applicable input method."
48 #endif
50 static const char *config_keys[] =
51 {
52 "Device",
53 "MountPoint",
54 "FSType",
55 "IgnoreSelected",
56 "ReportByDevice",
57 "ReportInodes",
58 "ValuesAbsolute",
59 "ValuesPercentage"
60 };
61 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
63 static ignorelist_t *il_device = NULL;
64 static ignorelist_t *il_mountpoint = NULL;
65 static ignorelist_t *il_fstype = NULL;
67 static _Bool by_device = 0;
68 static _Bool report_inodes = 0;
69 static _Bool values_absolute = 1;
70 static _Bool values_percentage = 0;
72 static int df_init (void)
73 {
74 if (il_device == NULL)
75 il_device = ignorelist_create (1);
76 if (il_mountpoint == NULL)
77 il_mountpoint = ignorelist_create (1);
78 if (il_fstype == NULL)
79 il_fstype = ignorelist_create (1);
81 return (0);
82 }
84 static int df_config (const char *key, const char *value)
85 {
86 df_init ();
88 if (strcasecmp (key, "Device") == 0)
89 {
90 if (ignorelist_add (il_device, value))
91 return (1);
92 return (0);
93 }
94 else if (strcasecmp (key, "MountPoint") == 0)
95 {
96 if (ignorelist_add (il_mountpoint, value))
97 return (1);
98 return (0);
99 }
100 else if (strcasecmp (key, "FSType") == 0)
101 {
102 if (ignorelist_add (il_fstype, value))
103 return (1);
104 return (0);
105 }
106 else if (strcasecmp (key, "IgnoreSelected") == 0)
107 {
108 if (IS_TRUE (value))
109 {
110 ignorelist_set_invert (il_device, 0);
111 ignorelist_set_invert (il_mountpoint, 0);
112 ignorelist_set_invert (il_fstype, 0);
113 }
114 else
115 {
116 ignorelist_set_invert (il_device, 1);
117 ignorelist_set_invert (il_mountpoint, 1);
118 ignorelist_set_invert (il_fstype, 1);
119 }
120 return (0);
121 }
122 else if (strcasecmp (key, "ReportByDevice") == 0)
123 {
124 if (IS_TRUE (value))
125 by_device = 1;
127 return (0);
128 }
129 else if (strcasecmp (key, "ReportInodes") == 0)
130 {
131 if (IS_TRUE (value))
132 report_inodes = 1;
133 else
134 report_inodes = 0;
136 return (0);
137 }
138 else if (strcasecmp (key, "ValuesAbsolute") == 0)
139 {
140 if (IS_TRUE (value))
141 values_absolute = 1;
142 else
143 values_absolute = 0;
145 return (0);
146 }
147 else if (strcasecmp (key, "ValuesPercentage") == 0)
148 {
149 if (IS_TRUE (value))
150 values_percentage = 1;
151 else
152 values_percentage = 0;
154 return (0);
155 }
157 return (-1);
158 }
160 __attribute__ ((nonnull(2)))
161 static void df_submit_one (char *plugin_instance,
162 const char *type, const char *type_instance,
163 gauge_t value)
164 {
165 value_t values[1];
166 value_list_t vl = VALUE_LIST_INIT;
168 values[0].gauge = value;
170 vl.values = values;
171 vl.values_len = 1;
172 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
173 sstrncpy (vl.plugin, "df", sizeof (vl.plugin));
174 if (plugin_instance != NULL)
175 sstrncpy (vl.plugin_instance, plugin_instance,
176 sizeof (vl.plugin_instance));
177 sstrncpy (vl.type, type, sizeof (vl.type));
178 if (type_instance != NULL)
179 sstrncpy (vl.type_instance, type_instance,
180 sizeof (vl.type_instance));
182 plugin_dispatch_values (&vl);
183 } /* void df_submit_one */
185 static int df_read (void)
186 {
187 #if HAVE_STATVFS
188 struct statvfs statbuf;
189 #elif HAVE_STATFS
190 struct statfs statbuf;
191 #endif
192 /* struct STATANYFS statbuf; */
193 cu_mount_t *mnt_list;
194 cu_mount_t *mnt_ptr;
196 mnt_list = NULL;
197 if (cu_mount_getlist (&mnt_list) == NULL)
198 {
199 ERROR ("df plugin: cu_mount_getlist failed.");
200 return (-1);
201 }
203 for (mnt_ptr = mnt_list; mnt_ptr != NULL; mnt_ptr = mnt_ptr->next)
204 {
205 unsigned long long blocksize;
206 char disk_name[256];
207 cu_mount_t *dup_ptr;
208 uint64_t blk_free;
209 uint64_t blk_reserved;
210 uint64_t blk_used;
212 char const *dev = (mnt_ptr->spec_device != NULL)
213 ? mnt_ptr->spec_device
214 : mnt_ptr->device;
216 if (ignorelist_match (il_device, dev))
217 continue;
218 if (ignorelist_match (il_mountpoint, mnt_ptr->dir))
219 continue;
220 if (ignorelist_match (il_fstype, mnt_ptr->type))
221 continue;
223 /* search for duplicates *in front of* the current mnt_ptr. */
224 for (dup_ptr = mnt_list; dup_ptr != NULL; dup_ptr = dup_ptr->next)
225 {
226 /* No duplicate found: mnt_ptr is the first of its kind. */
227 if (dup_ptr == mnt_ptr)
228 {
229 dup_ptr = NULL;
230 break;
231 }
233 /* Duplicate found: leave non-NULL dup_ptr. */
234 if (by_device && (strcmp (mnt_ptr->spec_device, dup_ptr->spec_device) == 0))
235 break;
236 else if (!by_device && (strcmp (mnt_ptr->dir, dup_ptr->dir) == 0))
237 break;
238 }
240 /* ignore duplicates */
241 if (dup_ptr != NULL)
242 continue;
244 if (STATANYFS (mnt_ptr->dir, &statbuf) < 0)
245 {
246 char errbuf[1024];
247 ERROR (STATANYFS_STR"(%s) failed: %s",
248 mnt_ptr->dir,
249 sstrerror (errno, errbuf,
250 sizeof (errbuf)));
251 continue;
252 }
254 if (!statbuf.f_blocks)
255 continue;
257 if (by_device)
258 {
259 /* eg, /dev/hda1 -- strip off the "/dev/" */
260 if (strncmp (dev, "/dev/", strlen ("/dev/")) == 0)
261 sstrncpy (disk_name, dev + strlen ("/dev/"), sizeof (disk_name));
262 else
263 sstrncpy (disk_name, dev, sizeof (disk_name));
265 if (strlen(disk_name) < 1)
266 {
267 DEBUG("df: no device name for mountpoint %s, skipping", mnt_ptr->dir);
268 continue;
269 }
270 }
271 else
272 {
273 if (strcmp (mnt_ptr->dir, "/") == 0)
274 sstrncpy (disk_name, "root", sizeof (disk_name));
275 else
276 {
277 int i, len;
279 sstrncpy (disk_name, mnt_ptr->dir + 1, sizeof (disk_name));
280 len = strlen (disk_name);
282 for (i = 0; i < len; i++)
283 if (disk_name[i] == '/')
284 disk_name[i] = '-';
285 }
286 }
288 blocksize = BLOCKSIZE(statbuf);
290 /*
291 * Sanity-check for the values in the struct
292 */
293 /* Check for negative "available" byes. For example UFS can
294 * report negative free space for user. Notice. blk_reserved
295 * will start to diminish after this. */
296 #if HAVE_STATVFS
297 /* Cast and temporary variable are needed to avoid
298 * compiler warnings.
299 * ((struct statvfs).f_bavail is unsigned (POSIX)) */
300 int64_t signed_bavail = (int64_t) statbuf.f_bavail;
301 if (signed_bavail < 0)
302 statbuf.f_bavail = 0;
303 #elif HAVE_STATFS
304 if (statbuf.f_bavail < 0)
305 statbuf.f_bavail = 0;
306 #endif
307 /* Make sure that f_blocks >= f_bfree >= f_bavail */
308 if (statbuf.f_bfree < statbuf.f_bavail)
309 statbuf.f_bfree = statbuf.f_bavail;
310 if (statbuf.f_blocks < statbuf.f_bfree)
311 statbuf.f_blocks = statbuf.f_bfree;
313 blk_free = (uint64_t) statbuf.f_bavail;
314 blk_reserved = (uint64_t) (statbuf.f_bfree - statbuf.f_bavail);
315 blk_used = (uint64_t) (statbuf.f_blocks - statbuf.f_bfree);
317 if (values_absolute)
318 {
319 df_submit_one (disk_name, "df_complex", "free",
320 (gauge_t) (blk_free * blocksize));
321 df_submit_one (disk_name, "df_complex", "reserved",
322 (gauge_t) (blk_reserved * blocksize));
323 df_submit_one (disk_name, "df_complex", "used",
324 (gauge_t) (blk_used * blocksize));
325 }
327 if (values_percentage)
328 {
329 if (statbuf.f_blocks > 0)
330 {
331 df_submit_one (disk_name, "percent_bytes", "free",
332 (gauge_t) ((float_t)(blk_free) / statbuf.f_blocks * 100));
333 df_submit_one (disk_name, "percent_bytes", "reserved",
334 (gauge_t) ((float_t)(blk_reserved) / statbuf.f_blocks * 100));
335 df_submit_one (disk_name, "percent_bytes", "used",
336 (gauge_t) ((float_t)(blk_used) / statbuf.f_blocks * 100));
337 }
338 else return (-1);
339 }
341 /* inode handling */
342 if (report_inodes && statbuf.f_files != 0 && statbuf.f_ffree != 0)
343 {
344 uint64_t inode_free;
345 uint64_t inode_reserved;
346 uint64_t inode_used;
348 /* Sanity-check for the values in the struct */
349 if (statbuf.f_ffree < statbuf.f_favail)
350 statbuf.f_ffree = statbuf.f_favail;
351 if (statbuf.f_files < statbuf.f_ffree)
352 statbuf.f_files = statbuf.f_ffree;
354 inode_free = (uint64_t) statbuf.f_favail;
355 inode_reserved = (uint64_t) (statbuf.f_ffree - statbuf.f_favail);
356 inode_used = (uint64_t) (statbuf.f_files - statbuf.f_ffree);
358 if (values_percentage)
359 {
360 if (statbuf.f_files > 0)
361 {
362 df_submit_one (disk_name, "percent_inodes", "free",
363 (gauge_t) ((float_t)(inode_free) / statbuf.f_files * 100));
364 df_submit_one (disk_name, "percent_inodes", "reserved",
365 (gauge_t) ((float_t)(inode_reserved) / statbuf.f_files * 100));
366 df_submit_one (disk_name, "percent_inodes", "used",
367 (gauge_t) ((float_t)(inode_used) / statbuf.f_files * 100));
368 }
369 else return (-1);
370 }
371 if (values_absolute)
372 {
373 df_submit_one (disk_name, "df_inodes", "free",
374 (gauge_t) inode_free);
375 df_submit_one (disk_name, "df_inodes", "reserved",
376 (gauge_t) inode_reserved);
377 df_submit_one (disk_name, "df_inodes", "used",
378 (gauge_t) inode_used);
379 }
380 }
381 }
383 cu_mount_freelist (mnt_list);
385 return (0);
386 } /* int df_read */
388 void module_register (void)
389 {
390 plugin_register_config ("df", df_config,
391 config_keys, config_keys_num);
392 plugin_register_init ("df", df_init);
393 plugin_register_read ("df", df_read);
394 } /* void module_register */