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