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