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       ERROR(STATANYFS_STR "(%s) failed: %s", mnt_ptr->dir, STRERRNO);
 206       continue;
 207     }
 208
 209     if (!statbuf.f_blocks)
 210       continue;
 211
 212     if (by_device) {
 213       /* eg, /dev/hda1  -- strip off the "/dev/" */
 214       if (strncmp(dev, "/dev/", strlen("/dev/")) == 0)
 215         sstrncpy(disk_name, dev + strlen("/dev/"), sizeof(disk_name));
 216       else
 217         sstrncpy(disk_name, dev, sizeof(disk_name));
 218
 219       if (strlen(disk_name) < 1) {
 220         DEBUG("df: no device name for mountpoint %s, skipping", mnt_ptr->dir);
 221         continue;
 222       }
 223     } else {
 224       if (strcmp(mnt_ptr->dir, "/") == 0)
 225         sstrncpy(disk_name, "root", sizeof(disk_name));
 226       else {
 227         int len;
 228
 229         sstrncpy(disk_name, mnt_ptr->dir + 1, sizeof(disk_name));
 230         len = strlen(disk_name);
 231
 232         for (int i = 0; i < len; i++)
 233           if (disk_name[i] == '/')
 234             disk_name[i] = '-';
 235       }
 236     }
 237
 238     blocksize = BLOCKSIZE(statbuf);
 239
 240 /*
 241  * Sanity-check for the values in the struct
 242  */
 243 /* Check for negative "available" byes. For example UFS can
 244  * report negative free space for user. Notice. blk_reserved
 245  * will start to diminish after this. */
 246 #if HAVE_STATVFS
 247     /* Cast and temporary variable are needed to avoid
 248      * compiler warnings.
 249      * ((struct statvfs).f_bavail is unsigned (POSIX)) */
 250     int64_t signed_bavail = (int64_t)statbuf.f_bavail;
 251     if (signed_bavail < 0)
 252       statbuf.f_bavail = 0;
 253 #elif HAVE_STATFS
 254     if (statbuf.f_bavail < 0)
 255       statbuf.f_bavail = 0;
 256 #endif
 257     /* Make sure that f_blocks >= f_bfree >= f_bavail */
 258     if (statbuf.f_bfree < statbuf.f_bavail)
 259       statbuf.f_bfree = statbuf.f_bavail;
 260     if (statbuf.f_blocks < statbuf.f_bfree)
 261       statbuf.f_blocks = statbuf.f_bfree;
 262
 263     blk_free = (uint64_t)statbuf.f_bavail;
 264     blk_reserved = (uint64_t)(statbuf.f_bfree - statbuf.f_bavail);
 265     blk_used = (uint64_t)(statbuf.f_blocks - statbuf.f_bfree);
 266
 267     if (values_absolute) {
 268       df_submit_one(disk_name, "df_complex", "free",
 269                     (gauge_t)(blk_free * blocksize));
 270       df_submit_one(disk_name, "df_complex", "reserved",
 271                     (gauge_t)(blk_reserved * blocksize));
 272       df_submit_one(disk_name, "df_complex", "used",
 273                     (gauge_t)(blk_used * blocksize));
 274     }
 275
 276     if (values_percentage) {
 277       if (statbuf.f_blocks > 0) {
 278         df_submit_one(disk_name, "percent_bytes", "free",
 279                       (gauge_t)((float_t)(blk_free) / statbuf.f_blocks * 100));
 280         df_submit_one(
 281             disk_name, "percent_bytes", "reserved",
 282             (gauge_t)((float_t)(blk_reserved) / statbuf.f_blocks * 100));
 283         df_submit_one(disk_name, "percent_bytes", "used",
 284                       (gauge_t)((float_t)(blk_used) / statbuf.f_blocks * 100));
 285       } else
 286         return -1;
 287     }
 288
 289     /* inode handling */
 290     if (report_inodes && statbuf.f_files != 0 && statbuf.f_ffree != 0) {
 291       uint64_t inode_free;
 292       uint64_t inode_reserved;
 293       uint64_t inode_used;
 294
 295       /* Sanity-check for the values in the struct */
 296       if (statbuf.f_ffree < statbuf.f_favail)
 297         statbuf.f_ffree = statbuf.f_favail;
 298       if (statbuf.f_files < statbuf.f_ffree)
 299         statbuf.f_files = statbuf.f_ffree;
 300
 301       inode_free = (uint64_t)statbuf.f_favail;
 302       inode_reserved = (uint64_t)(statbuf.f_ffree - statbuf.f_favail);
 303       inode_used = (uint64_t)(statbuf.f_files - statbuf.f_ffree);
 304
 305       if (values_percentage) {
 306         if (statbuf.f_files > 0) {
 307           df_submit_one(
 308               disk_name, "percent_inodes", "free",
 309               (gauge_t)((float_t)(inode_free) / statbuf.f_files * 100));
 310           df_submit_one(
 311               disk_name, "percent_inodes", "reserved",
 312               (gauge_t)((float_t)(inode_reserved) / statbuf.f_files * 100));
 313           df_submit_one(
 314               disk_name, "percent_inodes", "used",
 315               (gauge_t)((float_t)(inode_used) / statbuf.f_files * 100));
 316         } else
 317           return -1;
 318       }
 319       if (values_absolute) {
 320         df_submit_one(disk_name, "df_inodes", "free", (gauge_t)inode_free);
 321         df_submit_one(disk_name, "df_inodes", "reserved",
 322                       (gauge_t)inode_reserved);
 323         df_submit_one(disk_name, "df_inodes", "used", (gauge_t)inode_used);
 324       }
 325     }
 326   }
 327
 328   cu_mount_freelist(mnt_list);
 329
 330   return 0;
 331 } /* int df_read */
 332
 333 void module_register(void) {
 334   plugin_register_config("df", df_config, config_keys, config_keys_num);
 335   plugin_register_init("df", df_init);
 336   plugin_register_read("df", df_read);
 337 } /* void module_register */