src/swap.c

   1 /**
   2  * collectd - src/swap.c
   3  * Copyright (C) 2005-2007  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25
  26 #if HAVE_SYS_SWAP_H
  27 # include <sys/swap.h>
  28 #endif
  29 #if HAVE_SYS_PARAM_H
  30 #  include <sys/param.h>
  31 #endif
  32 #if HAVE_SYS_SYSCTL_H
  33 #  include <sys/sysctl.h>
  34 #endif
  35 #if HAVE_KVM_H
  36 #  include <kvm.h>
  37 #endif
  38
  39 #if KERNEL_LINUX || HAVE_LIBKSTAT || defined(VM_SWAPUSAGE) || HAVE_LIBKVM || HAVE_LIBSTATGRAB
  40 # define SWAP_HAVE_READ 1
  41 #else
  42 # define SWAP_HAVE_READ 0
  43 #endif
  44
  45 #undef  MAX
  46 #define MAX(x,y) ((x) > (y) ? (x) : (y))
  47
  48 #if SWAP_HAVE_READ
  49 #if KERNEL_LINUX
  50 /* No global variables */
  51 /* #endif KERNEL_LINUX */
  52
  53 #elif HAVE_LIBKSTAT
  54 static unsigned long long pagesize;
  55 static kstat_t *ksp;
  56 /* #endif HAVE_LIBKSTAT */
  57
  58 #elif defined(VM_SWAPUSAGE)
  59 /* No global variables */
  60 /* #endif defined(VM_SWAPUSAGE) */
  61
  62 #elif HAVE_LIBKVM
  63 static kvm_t *kvm_obj = NULL;
  64 int kvm_pagesize;
  65 /* #endif HAVE_LIBKVM */
  66
  67 #elif HAVE_LIBSTATGRAB
  68 /* No global variables */
  69 #endif /* HAVE_LIBSTATGRAB */
  70
  71 static int swap_init (void)
  72 {
  73 #if KERNEL_LINUX
  74         /* No init stuff */
  75 /* #endif KERNEL_LINUX */
  76
  77 #elif HAVE_LIBKSTAT
  78         /* getpagesize(3C) tells me this does not fail.. */
  79         pagesize = (unsigned long long) getpagesize ();
  80         if (get_kstat (&ksp, "unix", 0, "system_pages"))
  81                 ksp = NULL;
  82 /* #endif HAVE_LIBKSTAT */
  83
  84 #elif defined(VM_SWAPUSAGE)
  85         /* No init stuff */
  86 /* #endif defined(VM_SWAPUSAGE) */
  87
  88 #elif HAVE_LIBKVM
  89         if (kvm_obj != NULL)
  90         {
  91                 kvm_close (kvm_obj);
  92                 kvm_obj = NULL;
  93         }
  94
  95         kvm_pagesize = getpagesize ();
  96
  97         if ((kvm_obj = kvm_open (NULL, /* execfile */
  98                                         NULL, /* corefile */
  99                                         NULL, /* swapfile */
 100                                         O_RDONLY, /* flags */
 101                                         NULL)) /* errstr */
 102                         == NULL)
 103         {
 104                 ERROR ("swap plugin: kvm_open failed.");
 105                 return (-1);
 106         }
 107 /* #endif HAVE_LIBKVM */
 108
 109 #elif HAVE_LIBSTATGRAB
 110         /* No init stuff */
 111 #endif /* HAVE_LIBSTATGRAB */
 112
 113         return (0);
 114 }
 115
 116 static void swap_submit (const char *type_instance, double value)
 117 {
 118         value_t values[1];
 119         value_list_t vl = VALUE_LIST_INIT;
 120
 121         values[0].gauge = value;
 122
 123         vl.values = values;
 124         vl.values_len = 1;
 125         vl.time = time (NULL);
 126         strcpy (vl.host, hostname_g);
 127         strcpy (vl.plugin, "swap");
 128         strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 129
 130         plugin_dispatch_values ("swap", &vl);
 131 } /* void swap_submit */
 132
 133 static int swap_read (void)
 134 {
 135 #if KERNEL_LINUX
 136         FILE *fh;
 137         char buffer[1024];
 138
 139         char *fields[8];
 140         int numfields;
 141
 142         unsigned long long swap_used   = 0LL;
 143         unsigned long long swap_cached = 0LL;
 144         unsigned long long swap_free   = 0LL;
 145         unsigned long long swap_total  = 0LL;
 146
 147         if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
 148         {
 149                 char errbuf[1024];
 150                 WARNING ("memory: fopen: %s",
 151                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 152                 return (-1);
 153         }
 154
 155         while (fgets (buffer, 1024, fh) != NULL)
 156         {
 157                 unsigned long long *val = NULL;
 158
 159                 if (strncasecmp (buffer, "SwapTotal:", 10) == 0)
 160                         val = &swap_total;
 161                 else if (strncasecmp (buffer, "SwapFree:", 9) == 0)
 162                         val = &swap_free;
 163                 else if (strncasecmp (buffer, "SwapCached:", 11) == 0)
 164                         val = &swap_cached;
 165                 else
 166                         continue;
 167
 168                 numfields = strsplit (buffer, fields, 8);
 169
 170                 if (numfields < 2)
 171                         continue;
 172
 173                 *val = atoll (fields[1]) * 1024LL;
 174         }
 175
 176         if (fclose (fh))
 177         {
 178                 char errbuf[1024];
 179                 WARNING ("memory: fclose: %s",
 180                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 181         }
 182
 183         if ((swap_total == 0LL) || ((swap_free + swap_cached) > swap_total))
 184                 return (-1);
 185
 186         swap_used = swap_total - (swap_free + swap_cached);
 187
 188         swap_submit ("used", swap_used);
 189         swap_submit ("free", swap_free);
 190         swap_submit ("cached", swap_cached);
 191 /* #endif KERNEL_LINUX */
 192
 193 #elif HAVE_LIBKSTAT
 194         unsigned long long swap_alloc;
 195         unsigned long long swap_resv;
 196         unsigned long long swap_avail;
 197
 198         struct anoninfo ai;
 199
 200         if (swapctl (SC_AINFO, &ai) == -1)
 201         {
 202                 char errbuf[1024];
 203                 ERROR ("swap plugin: swapctl failed: %s",
 204                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 205                 return (-1);
 206         }
 207
 208         /*
 209          * Calculations from:
 210          * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
 211          * Also see:
 212          * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
 213          * /usr/include/vm/anon.h
 214          *
 215          * In short, swap -s shows: allocated + reserved = used, available
 216          *
 217          * However, Solaris does not allow to allocated/reserved more than the
 218          * available swap (physical memory + disk swap), so the pedant may
 219          * prefer: allocated + unallocated = reserved, available
 220          *
 221          * We map the above to: used + resv = n/a, free
 222          *
 223          * Does your brain hurt yet?  - Christophe Kalt
 224          *
 225          * Oh, and in case you wonder,
 226          * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
 227          * can suffer from a 32bit overflow.
 228          */
 229         swap_alloc  = ai.ani_max - ai.ani_free;
 230         swap_alloc *= pagesize;
 231         swap_resv   = ai.ani_resv + ai.ani_free - ai.ani_max;
 232         swap_resv  *= pagesize;
 233         swap_avail  = ai.ani_max - ai.ani_resv;
 234         swap_avail *= pagesize;
 235
 236         swap_submit ("used", swap_alloc);
 237         swap_submit ("free", swap_avail);
 238         swap_submit ("reserved", swap_resv - swap_alloc);
 239 /* #endif HAVE_LIBKSTAT */
 240
 241 #elif defined(VM_SWAPUSAGE)
 242         int              mib[3];
 243         size_t           mib_len;
 244         struct xsw_usage sw_usage;
 245         size_t           sw_usage_len;
 246
 247         mib_len = 2;
 248         mib[0]  = CTL_VM;
 249         mib[1]  = VM_SWAPUSAGE;
 250
 251         sw_usage_len = sizeof (struct xsw_usage);
 252
 253         if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
 254                 return (-1);
 255
 256         /* The returned values are bytes. */
 257         swap_submit ("used", sw_usage.xsu_used);
 258         swap_submit ("free", sw_usage.xsu_avail);
 259 /* #endif VM_SWAPUSAGE */
 260
 261 #elif HAVE_LIBKVM
 262         struct kvm_swap data_s;
 263         int             status;
 264
 265         unsigned long long used;
 266         unsigned long long free;
 267         unsigned long long total;
 268
 269         if (kvm_obj == NULL)
 270                 return (-1);
 271
 272         /* only one structure => only get the grand total, no details */
 273         status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
 274         if (status == -1)
 275                 return (-1);
 276
 277         total = (unsigned long long) data_s.ksw_total;
 278         used  = (unsigned long long) data_s.ksw_used;
 279
 280         total *= (unsigned long long) kvm_pagesize;
 281         used  *= (unsigned long long) kvm_pagesize;
 282
 283         free = total - used;
 284
 285         swap_submit ("used", used);
 286         swap_submit ("free", free);
 287 /* #endif HAVE_LIBKVM */
 288
 289 #elif HAVE_LIBSTATGRAB
 290         sg_swap_stats *swap;
 291
 292         swap = sg_get_swap_stats ();
 293
 294         if (swap == NULL)
 295                 return (-1);
 296
 297         swap_submit ("used", swap->used);
 298         swap_submit ("free", swap->free);
 299 #endif /* HAVE_LIBSTATGRAB */
 300
 301         return (0);
 302 } /* int swap_read */
 303 #endif /* SWAP_HAVE_READ */
 304
 305 void module_register (void)
 306 {
 307 #if SWAP_HAVE_READ
 308         plugin_register_init ("swap", swap_init);
 309         plugin_register_read ("swap", swap_read);
 310 #endif /* SWAP_HAVE_READ */
 311 } /* void module_register */