Merge branch 'collectd-5.7'
[collectd.git] / src / df.c
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  **/
23
24 #include "collectd.h"
25
26 #include "common.h"
27 #include "plugin.h"
28 #include "utils_ignorelist.h"
29 #include "utils_mount.h"
30
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
48
49 static const char *config_keys[] = {
50     "Device",         "MountPoint",   "FSType",         "IgnoreSelected",
51     "ReportByDevice", "ReportInodes", "ValuesAbsolute", "ValuesPercentage"};
52 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
53
54 static ignorelist_t *il_device = NULL;
55 static ignorelist_t *il_mountpoint = NULL;
56 static ignorelist_t *il_fstype = NULL;
57
58 static _Bool by_device = 0;
59 static _Bool report_inodes = 0;
60 static _Bool values_absolute = 1;
61 static _Bool values_percentage = 0;
62
63 static int df_init(void) {
64   if (il_device == NULL)
65     il_device = ignorelist_create(1);
66   if (il_mountpoint == NULL)
67     il_mountpoint = ignorelist_create(1);
68   if (il_fstype == NULL)
69     il_fstype = ignorelist_create(1);
70
71   return (0);
72 }
73
74 static int df_config(const char *key, const char *value) {
75   df_init();
76
77   if (strcasecmp(key, "Device") == 0) {
78     if (ignorelist_add(il_device, value))
79       return (1);
80     return (0);
81   } else if (strcasecmp(key, "MountPoint") == 0) {
82     if (ignorelist_add(il_mountpoint, value))
83       return (1);
84     return (0);
85   } else if (strcasecmp(key, "FSType") == 0) {
86     if (ignorelist_add(il_fstype, value))
87       return (1);
88     return (0);
89   } else if (strcasecmp(key, "IgnoreSelected") == 0) {
90     if (IS_TRUE(value)) {
91       ignorelist_set_invert(il_device, 0);
92       ignorelist_set_invert(il_mountpoint, 0);
93       ignorelist_set_invert(il_fstype, 0);
94     } else {
95       ignorelist_set_invert(il_device, 1);
96       ignorelist_set_invert(il_mountpoint, 1);
97       ignorelist_set_invert(il_fstype, 1);
98     }
99     return (0);
100   } else if (strcasecmp(key, "ReportByDevice") == 0) {
101     if (IS_TRUE(value))
102       by_device = 1;
103
104     return (0);
105   } else if (strcasecmp(key, "ReportInodes") == 0) {
106     if (IS_TRUE(value))
107       report_inodes = 1;
108     else
109       report_inodes = 0;
110
111     return (0);
112   } else if (strcasecmp(key, "ValuesAbsolute") == 0) {
113     if (IS_TRUE(value))
114       values_absolute = 1;
115     else
116       values_absolute = 0;
117
118     return (0);
119   } else if (strcasecmp(key, "ValuesPercentage") == 0) {
120     if (IS_TRUE(value))
121       values_percentage = 1;
122     else
123       values_percentage = 0;
124
125     return (0);
126   }
127
128   return (-1);
129 }
130
131 __attribute__((nonnull(2))) static void df_submit_one(char *plugin_instance,
132                                                       const char *type,
133                                                       const char *type_instance,
134                                                       gauge_t value) {
135   value_list_t vl = VALUE_LIST_INIT;
136
137   vl.values = &(value_t){.gauge = value};
138   vl.values_len = 1;
139   sstrncpy(vl.plugin, "df", sizeof(vl.plugin));
140   if (plugin_instance != NULL)
141     sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
142   sstrncpy(vl.type, type, sizeof(vl.type));
143   if (type_instance != NULL)
144     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
145
146   plugin_dispatch_values(&vl);
147 } /* void df_submit_one */
148
149 static int df_read(void) {
150 #if HAVE_STATVFS
151   struct statvfs statbuf;
152 #elif HAVE_STATFS
153   struct statfs statbuf;
154 #endif
155   /* struct STATANYFS statbuf; */
156   cu_mount_t *mnt_list;
157
158   mnt_list = NULL;
159   if (cu_mount_getlist(&mnt_list) == NULL) {
160     ERROR("df plugin: cu_mount_getlist failed.");
161     return (-1);
162   }
163
164   for (cu_mount_t *mnt_ptr = mnt_list; mnt_ptr != NULL;
165        mnt_ptr = mnt_ptr->next) {
166     unsigned long long blocksize;
167     char disk_name[256];
168     cu_mount_t *dup_ptr;
169     uint64_t blk_free;
170     uint64_t blk_reserved;
171     uint64_t blk_used;
172
173     char const *dev =
174         (mnt_ptr->spec_device != NULL) ? mnt_ptr->spec_device : mnt_ptr->device;
175
176     if (ignorelist_match(il_device, dev))
177       continue;
178     if (ignorelist_match(il_mountpoint, mnt_ptr->dir))
179       continue;
180     if (ignorelist_match(il_fstype, mnt_ptr->type))
181       continue;
182
183     /* search for duplicates *in front of* the current mnt_ptr. */
184     for (dup_ptr = mnt_list; dup_ptr != NULL; dup_ptr = dup_ptr->next) {
185       /* No duplicate found: mnt_ptr is the first of its kind. */
186       if (dup_ptr == mnt_ptr) {
187         dup_ptr = NULL;
188         break;
189       }
190
191       /* Duplicate found: leave non-NULL dup_ptr. */
192       if (by_device && (mnt_ptr->spec_device != NULL) &&
193           (dup_ptr->spec_device != NULL) &&
194           (strcmp(mnt_ptr->spec_device, dup_ptr->spec_device) == 0))
195         break;
196       else if (!by_device && (strcmp(mnt_ptr->dir, dup_ptr->dir) == 0))
197         break;
198     }
199
200     /* ignore duplicates */
201     if (dup_ptr != NULL)
202       continue;
203
204     if (STATANYFS(mnt_ptr->dir, &statbuf) < 0) {
205       char errbuf[1024];
206       ERROR(STATANYFS_STR "(%s) failed: %s", mnt_ptr->dir,
207             sstrerror(errno, errbuf, sizeof(errbuf)));
208       continue;
209     }
210
211     if (!statbuf.f_blocks)
212       continue;
213
214     if (by_device) {
215       /* eg, /dev/hda1  -- strip off the "/dev/" */
216       if (strncmp(dev, "/dev/", strlen("/dev/")) == 0)
217         sstrncpy(disk_name, dev + strlen("/dev/"), sizeof(disk_name));
218       else
219         sstrncpy(disk_name, dev, sizeof(disk_name));
220
221       if (strlen(disk_name) < 1) {
222         DEBUG("df: no device name for mountpoint %s, skipping", mnt_ptr->dir);
223         continue;
224       }
225     } else {
226       if (strcmp(mnt_ptr->dir, "/") == 0)
227         sstrncpy(disk_name, "root", sizeof(disk_name));
228       else {
229         int len;
230
231         sstrncpy(disk_name, mnt_ptr->dir + 1, sizeof(disk_name));
232         len = strlen(disk_name);
233
234         for (int i = 0; i < len; i++)
235           if (disk_name[i] == '/')
236             disk_name[i] = '-';
237       }
238     }
239
240     blocksize = BLOCKSIZE(statbuf);
241
242 /*
243  * Sanity-check for the values in the struct
244  */
245 /* Check for negative "available" byes. For example UFS can
246  * report negative free space for user. Notice. blk_reserved
247  * will start to diminish after this. */
248 #if HAVE_STATVFS
249     /* Cast and temporary variable are needed to avoid
250      * compiler warnings.
251      * ((struct statvfs).f_bavail is unsigned (POSIX)) */
252     int64_t signed_bavail = (int64_t)statbuf.f_bavail;
253     if (signed_bavail < 0)
254       statbuf.f_bavail = 0;
255 #elif HAVE_STATFS
256     if (statbuf.f_bavail < 0)
257       statbuf.f_bavail = 0;
258 #endif
259     /* Make sure that f_blocks >= f_bfree >= f_bavail */
260     if (statbuf.f_bfree < statbuf.f_bavail)
261       statbuf.f_bfree = statbuf.f_bavail;
262     if (statbuf.f_blocks < statbuf.f_bfree)
263       statbuf.f_blocks = statbuf.f_bfree;
264
265     blk_free = (uint64_t)statbuf.f_bavail;
266     blk_reserved = (uint64_t)(statbuf.f_bfree - statbuf.f_bavail);
267     blk_used = (uint64_t)(statbuf.f_blocks - statbuf.f_bfree);
268
269     if (values_absolute) {
270       df_submit_one(disk_name, "df_complex", "free",
271                     (gauge_t)(blk_free * blocksize));
272       df_submit_one(disk_name, "df_complex", "reserved",
273                     (gauge_t)(blk_reserved * blocksize));
274       df_submit_one(disk_name, "df_complex", "used",
275                     (gauge_t)(blk_used * blocksize));
276     }
277
278     if (values_percentage) {
279       if (statbuf.f_blocks > 0) {
280         df_submit_one(disk_name, "percent_bytes", "free",
281                       (gauge_t)((float_t)(blk_free) / statbuf.f_blocks * 100));
282         df_submit_one(
283             disk_name, "percent_bytes", "reserved",
284             (gauge_t)((float_t)(blk_reserved) / statbuf.f_blocks * 100));
285         df_submit_one(disk_name, "percent_bytes", "used",
286                       (gauge_t)((float_t)(blk_used) / statbuf.f_blocks * 100));
287       } else
288         return (-1);
289     }
290
291     /* inode handling */
292     if (report_inodes && statbuf.f_files != 0 && statbuf.f_ffree != 0) {
293       uint64_t inode_free;
294       uint64_t inode_reserved;
295       uint64_t inode_used;
296
297       /* Sanity-check for the values in the struct */
298       if (statbuf.f_ffree < statbuf.f_favail)
299         statbuf.f_ffree = statbuf.f_favail;
300       if (statbuf.f_files < statbuf.f_ffree)
301         statbuf.f_files = statbuf.f_ffree;
302
303       inode_free = (uint64_t)statbuf.f_favail;
304       inode_reserved = (uint64_t)(statbuf.f_ffree - statbuf.f_favail);
305       inode_used = (uint64_t)(statbuf.f_files - statbuf.f_ffree);
306
307       if (values_percentage) {
308         if (statbuf.f_files > 0) {
309           df_submit_one(
310               disk_name, "percent_inodes", "free",
311               (gauge_t)((float_t)(inode_free) / statbuf.f_files * 100));
312           df_submit_one(
313               disk_name, "percent_inodes", "reserved",
314               (gauge_t)((float_t)(inode_reserved) / statbuf.f_files * 100));
315           df_submit_one(
316               disk_name, "percent_inodes", "used",
317               (gauge_t)((float_t)(inode_used) / statbuf.f_files * 100));
318         } else
319           return (-1);
320       }
321       if (values_absolute) {
322         df_submit_one(disk_name, "df_inodes", "free", (gauge_t)inode_free);
323         df_submit_one(disk_name, "df_inodes", "reserved",
324                       (gauge_t)inode_reserved);
325         df_submit_one(disk_name, "df_inodes", "used", (gauge_t)inode_used);
326       }
327     }
328   }
329
330   cu_mount_freelist(mnt_list);
331
332   return (0);
333 } /* int df_read */
334
335 void module_register(void) {
336   plugin_register_config("df", df_config, config_keys, config_keys_num);
337   plugin_register_init("df", df_init);
338   plugin_register_read("df", df_read);
339 } /* void module_register */