/**
* collectd - src/swap.c
- * Copyright (C) 2005,2006 Florian octo Forster
+ * Copyright (C) 2005-2007 Florian octo Forster
*
* 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
#include "common.h"
#include "plugin.h"
-#define MODULE_NAME "swap"
-
-#if defined(KERNEL_LINUX) || defined(KERNEL_SOLARIS) || defined(HAVE_LIBSTATGRAB)
-# define SWAP_HAVE_READ 1
-#else
-# define SWAP_HAVE_READ 0
-#endif
-
#if HAVE_SYS_SWAP_H
# include <sys/swap.h>
#endif
+#if HAVE_SYS_PARAM_H
+# include <sys/param.h>
+#endif
+#if HAVE_SYS_SYSCTL_H
+# include <sys/sysctl.h>
+#endif
+#if HAVE_KVM_H
+# include <kvm.h>
+#endif
+
+#if HAVE_STATGRAB_H
+# include <statgrab.h>
+#endif
#undef MAX
#define MAX(x,y) ((x) > (y) ? (x) : (y))
-static char *swap_file = "swap.rrd";
+#if KERNEL_LINUX
+/* No global variables */
+/* #endif KERNEL_LINUX */
-/* 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;
-
-#ifdef KERNEL_SOLARIS
-static int pagesize;
+#elif HAVE_LIBKSTAT
+static unsigned long long pagesize;
static kstat_t *ksp;
-#endif /* KERNEL_SOLARIS */
+/* #endif HAVE_LIBKSTAT */
+
+#elif defined(VM_SWAPUSAGE)
+/* No global variables */
+/* #endif defined(VM_SWAPUSAGE) */
+
+#elif HAVE_LIBKVM
+static kvm_t *kvm_obj = NULL;
+int kvm_pagesize;
+/* #endif HAVE_LIBKVM */
+
+#elif HAVE_LIBSTATGRAB
+/* No global variables */
+/* #endif HAVE_LIBSTATGRAB */
+
+#else
+# error "No applicable input method."
+#endif /* HAVE_LIBSTATGRAB */
-static void swap_init (void)
+static int swap_init (void)
{
-#ifdef KERNEL_SOLARIS
+#if KERNEL_LINUX
+ /* No init stuff */
+/* #endif KERNEL_LINUX */
+
+#elif HAVE_LIBKSTAT
/* getpagesize(3C) tells me this does not fail.. */
- pagesize = getpagesize ();
+ pagesize = (unsigned long long) getpagesize ();
if (get_kstat (&ksp, "unix", 0, "system_pages"))
ksp = NULL;
-#endif /* KERNEL_SOLARIS */
+/* #endif HAVE_LIBKSTAT */
- return;
-}
+#elif defined(VM_SWAPUSAGE)
+ /* No init stuff */
+/* #endif defined(VM_SWAPUSAGE) */
-static void swap_write (char *host, char *inst, char *val)
-{
- rrd_update_file (host, swap_file, val, ds_def, ds_num);
+#elif HAVE_LIBKVM
+ if (kvm_obj != NULL)
+ {
+ kvm_close (kvm_obj);
+ kvm_obj = NULL;
+ }
+
+ kvm_pagesize = getpagesize ();
+
+ if ((kvm_obj = kvm_open (NULL, /* execfile */
+ NULL, /* corefile */
+ NULL, /* swapfile */
+ O_RDONLY, /* flags */
+ NULL)) /* errstr */
+ == NULL)
+ {
+ ERROR ("swap plugin: kvm_open failed.");
+ return (-1);
+ }
+/* #endif HAVE_LIBKVM */
+
+#elif HAVE_LIBSTATGRAB
+ /* No init stuff */
+#endif /* HAVE_LIBSTATGRAB */
+
+ 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, double value)
{
- 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;
+ values[0].gauge = value;
- plugin_submit (MODULE_NAME, "-", buffer);
-}
+ vl.values = values;
+ vl.values_len = 1;
+ vl.time = time (NULL);
+ strcpy (vl.host, hostname_g);
+ strcpy (vl.plugin, "swap");
+ strcpy (vl.type, "swap");
+ sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
+
+ plugin_dispatch_values (&vl);
+} /* void swap_submit */
-static void swap_read (void)
+static int swap_read (void)
{
-#ifdef KERNEL_LINUX
+#if KERNEL_LINUX
FILE *fh;
char buffer[1024];
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)
}
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);
-/* #endif defined(KERNEL_LINUX) */
+ swap_submit ("used", swap_used);
+ swap_submit ("free", swap_free);
+ swap_submit ("cached", swap_cached);
+/* #endif KERNEL_LINUX */
-#elif defined(KERNEL_SOLARIS)
+#elif HAVE_LIBKSTAT
unsigned long long swap_alloc;
unsigned long long swap_resv;
unsigned long long swap_avail;
- /* unsigned long long swap_free; */
-
- long long availrmem;
- long long swapfs_minfree;
struct anoninfo ai;
if (swapctl (SC_AINFO, &ai) == -1)
- return;
-
- availrmem = get_kstat_value (ksp, "availrmem");
- swapfs_minfree = get_kstat_value (ksp, "minfree");
-
- if ((availrmem < 0LL) || (swapfs_minfree < 0LL))
- return;
+ {
+ char errbuf[1024];
+ ERROR ("swap plugin: swapctl failed: %s",
+ sstrerror (errno, errbuf, sizeof (errbuf)));
+ return (-1);
+ }
- /*
- * Calculations learned by reading
- * http://www.itworld.com/Comp/2377/UIR980701perf/
+ /*
+ * Calculations from:
+ * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
+ * Also see:
+ * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
+ * /usr/include/vm/anon.h
+ *
+ * In short, swap -s shows: allocated + reserved = used, available
*
- * swap_resv += ani_resv
- * swap_alloc += MAX(ani_resv, ani_max) - ani_free
- * swap_avail += MAX(ani_max - ani_resv, 0) + (availrmem - swapfs_minfree)
- * swap_free += ani_free + (availrmem - swapfs_minfree)
+ * 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
*
- * To clear up the terminology a bit:
- * resv = reserved (but not neccessarily used)
- * alloc = used (neccessarily reserved)
- * avail = not reserved (neccessarily free)
- * free = not allocates (possibly reserved)
+ * Does your brain hurt yet? - Christophe Kalt
+ *
+ * Oh, and in case you wonder,
+ * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
+ * can suffer from a 32bit overflow.
*/
- swap_resv = pagesize * ai.ani_resv;
- swap_alloc = pagesize * (MAX(ai.ani_resv, ai.ani_max) - ai.ani_free);
- swap_avail = pagesize * (MAX(ai.ani_max - ai.ani_resv, 0) + (availrmem - swapfs_minfree));
- /* swap_free = pagesize * (ai.ani_free + (availrmem - swapfs_minfree)); */
+ 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 ("used", swap_alloc);
+ swap_submit ("free", swap_avail);
+ swap_submit ("reserved", swap_resv);
+/* #endif HAVE_LIBKSTAT */
+
+#elif defined(VM_SWAPUSAGE)
+ int mib[3];
+ size_t mib_len;
+ struct xsw_usage sw_usage;
+ size_t sw_usage_len;
+
+ mib_len = 2;
+ mib[0] = CTL_VM;
+ mib[1] = VM_SWAPUSAGE;
+
+ sw_usage_len = sizeof (struct xsw_usage);
+
+ if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
+ return (-1);
+
+ /* The returned values are bytes. */
+ swap_submit ("used", sw_usage.xsu_used);
+ swap_submit ("free", sw_usage.xsu_avail);
+/* #endif VM_SWAPUSAGE */
- swap_submit (swap_alloc, swap_avail, -1LL, swap_resv - swap_alloc);
-/* #endif defined(KERNEL_SOLARIS) */
+#elif HAVE_LIBKVM
+ struct kvm_swap data_s;
+ int status;
-#elif defined(HAVE_LIBSTATGRAB)
+ unsigned long long used;
+ unsigned long long free;
+ unsigned long long total;
+
+ if (kvm_obj == NULL)
+ 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 (-1);
+
+ total = (unsigned long long) data_s.ksw_total;
+ used = (unsigned long long) data_s.ksw_used;
+
+ total *= (unsigned long long) kvm_pagesize;
+ used *= (unsigned long long) kvm_pagesize;
+
+ free = total - used;
+
+ swap_submit ("used", used);
+ swap_submit ("free", free);
+/* #endif HAVE_LIBKVM */
+
+#elif HAVE_LIBSTATGRAB
sg_swap_stats *swap;
- if ((swap = sg_get_swap_stats ()) != NULL)
- swap_submit (swap->used, swap->free, -1LL, -1LL);
+ swap = sg_get_swap_stats ();
+
+ if (swap == NULL)
+ return (-1);
+
+ swap_submit ("used", swap->used);
+ swap_submit ("free", swap->free);
#endif /* HAVE_LIBSTATGRAB */
-}
-#else
-# define swap_read NULL
-#endif /* SWAP_HAVE_READ */
+
+ 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 */