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