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_t values[1];
165 value_list_t vl = VALUE_LIST_INIT;
167 values[0].gauge = value;
169 vl.values = values;
170 vl.values_len = 1;
171 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
172 sstrncpy (vl.plugin, "df", sizeof (vl.plugin));
173 if (plugin_instance != NULL)
174 sstrncpy (vl.plugin_instance, plugin_instance,
175 sizeof (vl.plugin_instance));
176 sstrncpy (vl.type, type, sizeof (vl.type));
177 if (type_instance != NULL)
178 sstrncpy (vl.type_instance, type_instance,
179 sizeof (vl.type_instance));
181 plugin_dispatch_values (&vl);
182 } /* void df_submit_one */
184 static int df_read (void)
185 {
186 #if HAVE_STATVFS
187 struct statvfs statbuf;
188 #elif HAVE_STATFS
189 struct statfs statbuf;
190 #endif
191 /* struct STATANYFS statbuf; */
192 cu_mount_t *mnt_list;
194 mnt_list = NULL;
195 if (cu_mount_getlist (&mnt_list) == NULL)
196 {
197 ERROR ("df plugin: cu_mount_getlist failed.");
198 return (-1);
199 }
201 for (cu_mount_t *mnt_ptr = mnt_list; mnt_ptr != NULL; mnt_ptr = mnt_ptr->next)
202 {
203 unsigned long long blocksize;
204 char disk_name[256];
205 cu_mount_t *dup_ptr;
206 uint64_t blk_free;
207 uint64_t blk_reserved;
208 uint64_t blk_used;
210 char const *dev = (mnt_ptr->spec_device != NULL)
211 ? mnt_ptr->spec_device
212 : mnt_ptr->device;
214 if (ignorelist_match (il_device, dev))
215 continue;
216 if (ignorelist_match (il_mountpoint, mnt_ptr->dir))
217 continue;
218 if (ignorelist_match (il_fstype, mnt_ptr->type))
219 continue;
221 /* search for duplicates *in front of* the current mnt_ptr. */
222 for (dup_ptr = mnt_list; dup_ptr != NULL; dup_ptr = dup_ptr->next)
223 {
224 /* No duplicate found: mnt_ptr is the first of its kind. */
225 if (dup_ptr == mnt_ptr)
226 {
227 dup_ptr = NULL;
228 break;
229 }
231 /* Duplicate found: leave non-NULL dup_ptr. */
232 if (by_device
233 && (mnt_ptr->spec_device != NULL)
234 && (dup_ptr->spec_device != NULL)
235 && (strcmp (mnt_ptr->spec_device, dup_ptr->spec_device) == 0))
236 break;
237 else if (!by_device && (strcmp (mnt_ptr->dir, dup_ptr->dir) == 0))
238 break;
239 }
241 /* ignore duplicates */
242 if (dup_ptr != NULL)
243 continue;
245 if (STATANYFS (mnt_ptr->dir, &statbuf) < 0)
246 {
247 char errbuf[1024];
248 ERROR (STATANYFS_STR"(%s) failed: %s",
249 mnt_ptr->dir,
250 sstrerror (errno, errbuf,
251 sizeof (errbuf)));
252 continue;
253 }
255 if (!statbuf.f_blocks)
256 continue;
258 if (by_device)
259 {
260 /* eg, /dev/hda1 -- strip off the "/dev/" */
261 if (strncmp (dev, "/dev/", strlen ("/dev/")) == 0)
262 sstrncpy (disk_name, dev + strlen ("/dev/"), sizeof (disk_name));
263 else
264 sstrncpy (disk_name, dev, sizeof (disk_name));
266 if (strlen(disk_name) < 1)
267 {
268 DEBUG("df: no device name for mountpoint %s, skipping", mnt_ptr->dir);
269 continue;
270 }
271 }
272 else
273 {
274 if (strcmp (mnt_ptr->dir, "/") == 0)
275 sstrncpy (disk_name, "root", sizeof (disk_name));
276 else
277 {
278 int len;
280 sstrncpy (disk_name, mnt_ptr->dir + 1, sizeof (disk_name));
281 len = strlen (disk_name);
283 for (int i = 0; i < len; i++)
284 if (disk_name[i] == '/')
285 disk_name[i] = '-';
286 }
287 }
289 blocksize = BLOCKSIZE(statbuf);
291 /*
292 * Sanity-check for the values in the struct
293 */
294 /* Check for negative "available" byes. For example UFS can
295 * report negative free space for user. Notice. blk_reserved
296 * will start to diminish after this. */
297 #if HAVE_STATVFS
298 /* Cast and temporary variable are needed to avoid
299 * compiler warnings.
300 * ((struct statvfs).f_bavail is unsigned (POSIX)) */
301 int64_t signed_bavail = (int64_t) statbuf.f_bavail;
302 if (signed_bavail < 0)
303 statbuf.f_bavail = 0;
304 #elif HAVE_STATFS
305 if (statbuf.f_bavail < 0)
306 statbuf.f_bavail = 0;
307 #endif
308 /* Make sure that f_blocks >= f_bfree >= f_bavail */
309 if (statbuf.f_bfree < statbuf.f_bavail)
310 statbuf.f_bfree = statbuf.f_bavail;
311 if (statbuf.f_blocks < statbuf.f_bfree)
312 statbuf.f_blocks = statbuf.f_bfree;
314 blk_free = (uint64_t) statbuf.f_bavail;
315 blk_reserved = (uint64_t) (statbuf.f_bfree - statbuf.f_bavail);
316 blk_used = (uint64_t) (statbuf.f_blocks - statbuf.f_bfree);
318 if (values_absolute)
319 {
320 df_submit_one (disk_name, "df_complex", "free",
321 (gauge_t) (blk_free * blocksize));
322 df_submit_one (disk_name, "df_complex", "reserved",
323 (gauge_t) (blk_reserved * blocksize));
324 df_submit_one (disk_name, "df_complex", "used",
325 (gauge_t) (blk_used * blocksize));
326 }
328 if (values_percentage)
329 {
330 if (statbuf.f_blocks > 0)
331 {
332 df_submit_one (disk_name, "percent_bytes", "free",
333 (gauge_t) ((float_t)(blk_free) / statbuf.f_blocks * 100));
334 df_submit_one (disk_name, "percent_bytes", "reserved",
335 (gauge_t) ((float_t)(blk_reserved) / statbuf.f_blocks * 100));
336 df_submit_one (disk_name, "percent_bytes", "used",
337 (gauge_t) ((float_t)(blk_used) / statbuf.f_blocks * 100));
338 }
339 else return (-1);
340 }
342 /* inode handling */
343 if (report_inodes && statbuf.f_files != 0 && statbuf.f_ffree != 0)
344 {
345 uint64_t inode_free;
346 uint64_t inode_reserved;
347 uint64_t inode_used;
349 /* Sanity-check for the values in the struct */
350 if (statbuf.f_ffree < statbuf.f_favail)
351 statbuf.f_ffree = statbuf.f_favail;
352 if (statbuf.f_files < statbuf.f_ffree)
353 statbuf.f_files = statbuf.f_ffree;
355 inode_free = (uint64_t) statbuf.f_favail;
356 inode_reserved = (uint64_t) (statbuf.f_ffree - statbuf.f_favail);
357 inode_used = (uint64_t) (statbuf.f_files - statbuf.f_ffree);
359 if (values_percentage)
360 {
361 if (statbuf.f_files > 0)
362 {
363 df_submit_one (disk_name, "percent_inodes", "free",
364 (gauge_t) ((float_t)(inode_free) / statbuf.f_files * 100));
365 df_submit_one (disk_name, "percent_inodes", "reserved",
366 (gauge_t) ((float_t)(inode_reserved) / statbuf.f_files * 100));
367 df_submit_one (disk_name, "percent_inodes", "used",
368 (gauge_t) ((float_t)(inode_used) / statbuf.f_files * 100));
369 }
370 else return (-1);
371 }
372 if (values_absolute)
373 {
374 df_submit_one (disk_name, "df_inodes", "free",
375 (gauge_t) inode_free);
376 df_submit_one (disk_name, "df_inodes", "reserved",
377 (gauge_t) inode_reserved);
378 df_submit_one (disk_name, "df_inodes", "used",
379 (gauge_t) inode_used);
380 }
381 }
382 }
384 cu_mount_freelist (mnt_list);
386 return (0);
387 } /* int df_read */
389 void module_register (void)
390 {
391 plugin_register_config ("df", df_config,
392 config_keys, config_keys_num);
393 plugin_register_init ("df", df_init);
394 plugin_register_read ("df", df_read);
395 } /* void module_register */