swap plugin: Fix a bug collecting swap I/O.
[collectd.git] / src / swap.c
index f906c99..46ba665 100644 (file)
@@ -1,11 +1,12 @@
 /**
  * collectd - src/swap.c
- * Copyright (C) 2005,2006  Florian octo Forster
+ * Copyright (C) 2005-2009  Florian octo Forster
+ * Copyright (C) 2009       Stefan Völkel
+ * Copyright (C) 2009       Manuel Sanmartin
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
+ * Free Software Foundation; only version 2 of the License is applicable.
  *
  * This program is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  * Authors:
  *   Florian octo Forster <octo at verplant.org>
+ *   Manuel Sanmartin
  **/
 
+#if HAVE_CONFIG_H
+# include "config.h"
+# undef HAVE_CONFIG_H
+#endif
+/* avoid swap.h error "Cannot use swapctl in the large files compilation environment" */
+#if HAVE_SYS_SWAP_H && !defined(_LP64) && _FILE_OFFSET_BITS == 64
+#  undef _FILE_OFFSET_BITS
+#  undef _LARGEFILE64_SOURCE
+#endif
+
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
 #if HAVE_SYS_SWAP_H
 # include <sys/swap.h>
 #endif
+#if HAVE_VM_ANON_H
+# include <vm/anon.h>
+#endif
 #if HAVE_SYS_PARAM_H
 #  include <sys/param.h>
 #endif
 #if HAVE_SYS_SYSCTL_H
 #  include <sys/sysctl.h>
 #endif
+#if HAVE_SYS_DKSTAT_H
+#  include <sys/dkstat.h>
+#endif
 #if HAVE_KVM_H
 #  include <kvm.h>
 #endif
 
-#define MODULE_NAME "swap"
+#if HAVE_STATGRAB_H
+# include <statgrab.h>
+#endif
 
-#if KERNEL_LINUX || HAVE_LIBKSTAT || defined(VM_SWAPUSAGE) || HAVE_LIBKVM || HAVE_LIBSTATGRAB
-# define SWAP_HAVE_READ 1
-#else
-# define SWAP_HAVE_READ 0
+#if HAVE_PERFSTAT
+# include <sys/protosw.h>
+# include <libperfstat.h>
 #endif
 
 #undef  MAX
 #define MAX(x,y) ((x) > (y) ? (x) : (y))
 
-static char *swap_file = "swap.rrd";
-
-/* 1099511627776 == 1TB ought to be enough for anyone ;) */
-static char *ds_def[] =
-{
-       "DS:used:GAUGE:"COLLECTD_HEARTBEAT":0:1099511627776",
-       "DS:free:GAUGE:"COLLECTD_HEARTBEAT":0:1099511627776",
-       "DS:cached:GAUGE:"COLLECTD_HEARTBEAT":0:1099511627776",
-       "DS:resv:GAUGE:"COLLECTD_HEARTBEAT":0:1099511627776",
-       NULL
-};
-static int ds_num = 4;
-
 #if KERNEL_LINUX
 /* No global variables */
 /* #endif KERNEL_LINUX */
 
 #elif HAVE_LIBKSTAT
-static unsigned long long pagesize;
+static derive_t pagesize;
 static kstat_t *ksp;
 /* #endif HAVE_LIBKSTAT */
 
+#elif HAVE_SWAPCTL
+/* No global variables */
+/* #endif HAVE_SWAPCTL */
+
 #elif defined(VM_SWAPUSAGE)
 /* No global variables */
 /* #endif defined(VM_SWAPUSAGE) */
 
-#elif HAVE_LIBKVM
+#elif HAVE_LIBKVM_GETSWAPINFO
 static kvm_t *kvm_obj = NULL;
 int kvm_pagesize;
-/* #endif HAVE_LIBKVM */
+/* #endif HAVE_LIBKVM_GETSWAPINFO */
 
 #elif HAVE_LIBSTATGRAB
 /* No global variables */
+/* #endif HAVE_LIBSTATGRAB */
+
+#elif HAVE_PERFSTAT
+static int pagesize;
+static perfstat_memory_total_t pmemory;
+/*# endif HAVE_PERFSTAT */
+
+#else
+# error "No applicable input method."
 #endif /* HAVE_LIBSTATGRAB */
 
-static void swap_init (void)
+static int swap_init (void)
 {
 #if KERNEL_LINUX
        /* No init stuff */
@@ -91,16 +110,20 @@ static void swap_init (void)
 
 #elif HAVE_LIBKSTAT
        /* getpagesize(3C) tells me this does not fail.. */
-       pagesize = (unsigned long long) getpagesize ();
+       pagesize = (derive_t) getpagesize ();
        if (get_kstat (&ksp, "unix", 0, "system_pages"))
                ksp = NULL;
 /* #endif HAVE_LIBKSTAT */
 
+#elif HAVE_SWAPCTL
+       /* No init stuff */
+/* #endif HAVE_SWAPCTL */
+
 #elif defined(VM_SWAPUSAGE)
        /* No init stuff */
 /* #endif defined(VM_SWAPUSAGE) */
 
-#elif HAVE_LIBKVM
+#elif HAVE_LIBKVM_GETSWAPINFO
        if (kvm_obj != NULL)
        {
                kvm_close (kvm_obj);
@@ -116,102 +139,171 @@ static void swap_init (void)
                                        NULL)) /* errstr */
                        == NULL)
        {
-               syslog (LOG_ERR, "swap plugin: kvm_open failed.");
-               return;
+               ERROR ("swap plugin: kvm_open failed.");
+               return (-1);
        }
-/* #endif HAVE_LIBKVM */
+/* #endif HAVE_LIBKVM_GETSWAPINFO */
 
 #elif HAVE_LIBSTATGRAB
        /* No init stuff */
-#endif /* HAVE_LIBSTATGRAB */
+/* #endif HAVE_LIBSTATGRAB */
 
-       return;
-}
+#elif HAVE_PERFSTAT
+       pagesize = getpagesize();
+#endif /* HAVE_PERFSTAT */
 
-static void swap_write (char *host, char *inst, char *val)
-{
-       rrd_update_file (host, swap_file, val, ds_def, ds_num);
+       return (0);
 }
 
-#if SWAP_HAVE_READ
-static void swap_submit (unsigned long long swap_used,
-               unsigned long long swap_free,
-               unsigned long long swap_cached,
-               unsigned long long swap_resv)
+static void swap_submit (const char *type_instance, derive_t value, unsigned type)
 {
-       char buffer[512];
+       value_t values[1];
+       value_list_t vl = VALUE_LIST_INIT;
 
-       if (snprintf (buffer, 512, "%u:%llu:%llu:%llu:%llu", (unsigned int) curtime,
-                               swap_used, swap_free, swap_cached, swap_resv) >= 512)
-               return;
+       switch (type)
+       {
+               case DS_TYPE_GAUGE:
+                       values[0].gauge = (gauge_t) value;
+                       sstrncpy (vl.type, "swap", sizeof (vl.type));
+                       break;
+               case DS_TYPE_DERIVE:
+                       values[0].derive = value;
+                       sstrncpy (vl.type, "swap_io", sizeof (vl.type));
+                       break;
+               default:
+                       ERROR ("swap plugin: swap_submit called with wrong"
+                               " type");
+       }
 
-       plugin_submit (MODULE_NAME, "-", buffer);
-}
+       vl.values = values;
+       vl.values_len = 1;
+       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
+       sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 
-static void swap_read (void)
+       plugin_dispatch_values (&vl);
+} /* void swap_submit */
+
+static int swap_read (void)
 {
 #if KERNEL_LINUX
        FILE *fh;
        char buffer[1024];
-       
+
        char *fields[8];
        int numfields;
 
-       unsigned long long swap_used   = 0LL;
-       unsigned long long swap_cached = 0LL;
-       unsigned long long swap_free   = 0LL;
-       unsigned long long swap_total  = 0LL;
+       _Bool old_kernel=0;
+
+       derive_t swap_used   = 0;
+       derive_t swap_cached = 0;
+       derive_t swap_free   = 0;
+       derive_t swap_total  = 0;
+       derive_t swap_in     = 0;
+       derive_t swap_out    = 0;
 
        if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
        {
-               syslog (LOG_WARNING, "memory: fopen: %s", strerror (errno));
-               return;
+               char errbuf[1024];
+               WARNING ("memory: fopen: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
        }
 
-       while (fgets (buffer, 1024, fh) != NULL)
+       while (fgets (buffer, sizeof (buffer), fh) != NULL)
        {
-               unsigned long long *val = NULL;
-
-               if (strncasecmp (buffer, "SwapTotal:", 10) == 0)
-                       val = &swap_total;
-               else if (strncasecmp (buffer, "SwapFree:", 9) == 0)
-                       val = &swap_free;
-               else if (strncasecmp (buffer, "SwapCached:", 11) == 0)
-                       val = &swap_cached;
-               else
-                       continue;
-
-               numfields = strsplit (buffer, fields, 8);
-
+               numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
                if (numfields < 2)
                        continue;
 
-               *val = atoll (fields[1]) * 1024LL;
+               if (strcasecmp (fields[0], "SwapTotal:") == 0)
+                       strtoderive (fields[1], &swap_total);
+               else if (strcasecmp (fields[0], "SwapFree:") == 0)
+                       strtoderive (fields[1], &swap_free);
+               else if (strcasecmp (fields[0], "SwapCached:") == 0)
+                       strtoderive (fields[1], &swap_cached);
        }
 
        if (fclose (fh))
-               syslog (LOG_WARNING, "memory: fclose: %s", strerror (errno));
+       {
+               char errbuf[1024];
+               WARNING ("memory: fclose: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+       }
 
        if ((swap_total == 0LL) || ((swap_free + swap_cached) > swap_total))
-               return;
+               return (-1);
 
        swap_used = swap_total - (swap_free + swap_cached);
 
-       swap_submit (swap_used, swap_free, swap_cached, -1LL);
+       if ((fh = fopen ("/proc/vmstat", "r")) == NULL)
+       {
+               // /proc/vmstat does not exist in kernels <2.6
+               if ((fh = fopen ("/proc/stat", "r")) == NULL )
+               {
+                       char errbuf[1024];
+                       WARNING ("swap: fopen: %s",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       return (-1);
+               }
+               else
+                       old_kernel = 1;
+       }
+
+       while (fgets (buffer, sizeof (buffer), fh) != NULL)
+       {
+               numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
+
+               if (!old_kernel)
+               {
+                       if (numfields != 2)
+                               continue;
+
+                       if (strcasecmp ("pswpin", fields[0]) == 0)
+                               strtoderive (fields[1], &swap_in);
+                       else if (strcasecmp ("pswpout", fields[0]) == 0)
+                               strtoderive (fields[1], &swap_out);
+               }
+               else /* if (old_kernel) */
+               {
+                       if (numfields != 3)
+                               continue;
+
+                       if (strcasecmp ("page", fields[0]) == 0)
+                       {
+                               strtoderive (fields[1], &swap_in);
+                               strtoderive (fields[2], &swap_out);
+                       }
+               }
+       } /* while (fgets) */
+
+       if (fclose (fh))
+       {
+               char errbuf[1024];
+               WARNING ("swap: fclose: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+       }
+
+       swap_submit ("used",   1024 * swap_used,   DS_TYPE_GAUGE);
+       swap_submit ("free",   1024 * swap_free,   DS_TYPE_GAUGE);
+       swap_submit ("cached", 1024 * swap_cached, DS_TYPE_GAUGE);
+       swap_submit ("in",  swap_in,  DS_TYPE_DERIVE);
+       swap_submit ("out", swap_out, DS_TYPE_DERIVE);
 /* #endif KERNEL_LINUX */
 
 #elif HAVE_LIBKSTAT
-       unsigned long long swap_alloc;
-       unsigned long long swap_resv;
-       unsigned long long swap_avail;
+       derive_t swap_alloc;
+       derive_t swap_resv;
+       derive_t swap_avail;
 
        struct anoninfo ai;
 
        if (swapctl (SC_AINFO, &ai) == -1)
        {
-               syslog (LOG_ERR, "swap plugin: swapctl failed: %s",
-                               strerror (errno));
-               return;
+               char errbuf[1024];
+               ERROR ("swap plugin: swapctl failed: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
        }
 
        /*
@@ -226,7 +318,7 @@ static void swap_read (void)
         * However, Solaris does not allow to allocated/reserved more than the
         * available swap (physical memory + disk swap), so the pedant may
         * prefer: allocated + unallocated = reserved, available
-        * 
+        *
         * We map the above to: used + resv = n/a, free
         *
         * Does your brain hurt yet?  - Christophe Kalt
@@ -235,22 +327,99 @@ static void swap_read (void)
         * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
         * can suffer from a 32bit overflow.
         */
-       swap_alloc  = ai.ani_max - ai.ani_free;
-       swap_alloc *= pagesize;
-       swap_resv   = ai.ani_resv + ai.ani_free - ai.ani_max;
-       swap_resv  *= pagesize;
-       swap_avail  = ai.ani_max - ai.ani_resv;
-       swap_avail *= pagesize;
-
-       swap_submit (swap_alloc, swap_avail, -1LL, swap_resv - swap_alloc);
+       swap_alloc  = (derive_t) ((ai.ani_max - ai.ani_free) * pagesize);
+       swap_resv   = (derive_t) ((ai.ani_resv + ai.ani_free - ai.ani_max)
+                       * pagesize);
+       swap_avail  = (derive_t) ((ai.ani_max - ai.ani_resv) * pagesize);
+
+       swap_submit ("used", swap_alloc, DS_TYPE_GAUGE);
+       swap_submit ("free", swap_avail, DS_TYPE_GAUGE);
+       swap_submit ("reserved", swap_resv, DS_TYPE_GAUGE);
 /* #endif HAVE_LIBKSTAT */
 
+#elif HAVE_SWAPCTL
+       struct swapent *swap_entries;
+       int swap_num;
+       int status;
+       int i;
+
+       derive_t used  = 0;
+       derive_t total = 0;
+
+       /*
+        * XXX: This is the syntax for the *BSD `swapctl', which has the
+        * following prototype:
+        *   swapctl (int cmd, void *arg, int misc);
+        *
+        * HP-UX and Solaris (and possibly other UNIXes) provide `swapctl',
+        * too, but with the following prototype:
+        *   swapctl (int cmd, void *arg);
+        *
+        * Solaris is usually handled in the KSTAT case above. For other UNIXes
+        * a separate case for the other version of `swapctl' may be necessary.
+        */
+       swap_num = swapctl (SWAP_NSWAP, NULL, 0);
+       if (swap_num < 0)
+       {
+               ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
+                               swap_num);
+               return (-1);
+       }
+       else if (swap_num == 0)
+               return (0);
+
+       swap_entries = calloc (swap_num, sizeof (*swap_entries));
+       if (swap_entries == NULL)
+       {
+               ERROR ("swap plugin: calloc failed.");
+               return (-1);
+       }
+
+       status = swapctl (SWAP_STATS, swap_entries, swap_num);
+       if (status != swap_num)
+       {
+               ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
+                               status);
+               sfree (swap_entries);
+               return (-1);
+       }
+
+#if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
+# define C_SWAP_BLOCK_SIZE ((derive_t) DEV_BSIZE)
+#else
+# define C_SWAP_BLOCK_SIZE ((derive_t) 512)
+#endif
+
+       for (i = 0; i < swap_num; i++)
+       {
+               if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
+                       continue;
+
+               used  += ((derive_t) swap_entries[i].se_inuse)
+                       * C_SWAP_BLOCK_SIZE;
+               total += ((derive_t) swap_entries[i].se_nblks)
+                       * C_SWAP_BLOCK_SIZE;
+       }
+
+       if (total < used)
+       {
+               ERROR ("swap plugin: Total swap space (%"PRIu64") "
+                               "is less than used swap space (%"PRIu64").",
+                               total, used);
+               return (-1);
+       }
+
+       swap_submit ("used", used, DS_TYPE_GAUGE);
+       swap_submit ("free", total - used, DS_TYPE_GAUGE);
+
+       sfree (swap_entries);
+/* #endif HAVE_SWAPCTL */
+
 #elif defined(VM_SWAPUSAGE)
        int              mib[3];
        size_t           mib_len;
        struct xsw_usage sw_usage;
        size_t           sw_usage_len;
-       int              status;
 
        mib_len = 2;
        mib[0]  = CTL_VM;
@@ -259,53 +428,70 @@ static void swap_read (void)
        sw_usage_len = sizeof (struct xsw_usage);
 
        if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
-               return;
+               return (-1);
 
        /* The returned values are bytes. */
-       swap_submit (sw_usage.xsu_used, sw_usage.xsu_avail, -1LL, -1LL);
+       swap_submit ("used", (derive_t) sw_usage.xsu_used, DS_TYPE_GAUGE);
+       swap_submit ("free", (derive_t) sw_usage.xsu_avail, DS_TYPE_GAUGE);
 /* #endif VM_SWAPUSAGE */
 
-#elif HAVE_LIBKVM
+#elif HAVE_LIBKVM_GETSWAPINFO
        struct kvm_swap data_s;
        int             status;
 
-       unsigned long long used;
-       unsigned long long free;
-       unsigned long long total;
+       derive_t used;
+       derive_t free;
+       derive_t total;
 
        if (kvm_obj == NULL)
-               return;
+               return (-1);
 
        /* only one structure => only get the grand total, no details */
        status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
        if (status == -1)
-               return;
+               return (-1);
 
-       total = (unsigned long long) data_s.ksw_total;
-       used  = (unsigned long long) data_s.ksw_used;
+       total = (derive_t) data_s.ksw_total;
+       used  = (derive_t) data_s.ksw_used;
 
-       total *= (unsigned long long) kvm_pagesize;
-       used  *= (unsigned long long) kvm_pagesize;
+       total *= (derive_t) kvm_pagesize;
+       used  *= (derive_t) kvm_pagesize;
 
        free = total - used;
 
-       swap_submit (used, free, -1LL, -1LL);
-/* #endif HAVE_LIBKVM */
+       swap_submit ("used", used, DS_TYPE_GAUGE);
+       swap_submit ("free", free, DS_TYPE_GAUGE);
+/* #endif HAVE_LIBKVM_GETSWAPINFO */
 
 #elif HAVE_LIBSTATGRAB
        sg_swap_stats *swap;
 
-       if ((swap = sg_get_swap_stats ()) != NULL)
-               swap_submit (swap->used, swap->free, -1LL, -1LL);
-#endif /* HAVE_LIBSTATGRAB */
-}
-#else
-# define swap_read NULL
-#endif /* SWAP_HAVE_READ */
+       swap = sg_get_swap_stats ();
+
+       if (swap == NULL)
+               return (-1);
+
+       swap_submit ("used", (derive_t) swap->used, DS_TYPE_GAUGE);
+       swap_submit ("free", (derive_t) swap->free, DS_TYPE_GAUGE);
+/* #endif  HAVE_LIBSTATGRAB */
+
+#elif HAVE_PERFSTAT
+        if(perfstat_memory_total(NULL, &pmemory, sizeof(perfstat_memory_total_t), 1) < 0)
+       {
+                char errbuf[1024];
+                WARNING ("memory plugin: perfstat_memory_total failed: %s",
+                        sstrerror (errno, errbuf, sizeof (errbuf)));
+                return (-1);
+        }
+       swap_submit ("used", (derive_t) (pmemory.pgsp_total - pmemory.pgsp_free) * pagesize, DS_TYPE_GAUGE);
+       swap_submit ("free", (derive_t) pmemory.pgsp_free * pagesize , DS_TYPE_GAUGE);
+#endif /* HAVE_PERFSTAT */
+
+       return (0);
+} /* int swap_read */
 
 void module_register (void)
 {
-       plugin_register (MODULE_NAME, swap_init, swap_read, swap_write);
-}
-
-#undef MODULE_NAME
+       plugin_register_init ("swap", swap_init);
+       plugin_register_read ("swap", swap_read);
+} /* void module_register */