src/swap.c

   1 /**
   2  * collectd - src/swap.c
   3  * Copyright (C) 2005-2009  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 #if HAVE_CONFIG_H
  23 # include "config.h"
  24 # undef HAVE_CONFIG_H
  25 #endif
  26 /* avoid swap.h error "Cannot use swapctl in the large files compilation environment" */
  27 #if HAVE_SYS_SWAP_H && !defined(_LP64) && _FILE_OFFSET_BITS == 64
  28 #  undef _FILE_OFFSET_BITS
  29 #  undef _LARGEFILE64_SOURCE
  30 #endif
  31
  32 #include "collectd.h"
  33 #include "common.h"
  34 #include "plugin.h"
  35
  36 #if HAVE_SYS_SWAP_H
  37 # include <sys/swap.h>
  38 #endif
  39 #if HAVE_VM_ANON_H
  40 # include <vm/anon.h>
  41 #endif
  42 #if HAVE_SYS_PARAM_H
  43 #  include <sys/param.h>
  44 #endif
  45 #if HAVE_SYS_SYSCTL_H
  46 #  include <sys/sysctl.h>
  47 #endif
  48 #if HAVE_SYS_DKSTAT_H
  49 #  include <sys/dkstat.h>
  50 #endif
  51 #if HAVE_KVM_H
  52 #  include <kvm.h>
  53 #endif
  54
  55 #if HAVE_STATGRAB_H
  56 # include <statgrab.h>
  57 #endif
  58
  59 #undef  MAX
  60 #define MAX(x,y) ((x) > (y) ? (x) : (y))
  61
  62 #if KERNEL_LINUX
  63 /* No global variables */
  64 /* #endif KERNEL_LINUX */
  65
  66 #elif HAVE_LIBKSTAT
  67 static unsigned long long pagesize;
  68 static kstat_t *ksp;
  69 /* #endif HAVE_LIBKSTAT */
  70
  71 #elif HAVE_SWAPCTL
  72 /* No global variables */
  73 /* #endif HAVE_SWAPCTL */
  74
  75 #elif defined(VM_SWAPUSAGE)
  76 /* No global variables */
  77 /* #endif defined(VM_SWAPUSAGE) */
  78
  79 #elif HAVE_LIBKVM_GETSWAPINFO
  80 static kvm_t *kvm_obj = NULL;
  81 int kvm_pagesize;
  82 /* #endif HAVE_LIBKVM_GETSWAPINFO */
  83
  84 #elif HAVE_LIBSTATGRAB
  85 /* No global variables */
  86 /* #endif HAVE_LIBSTATGRAB */
  87
  88 #else
  89 # error "No applicable input method."
  90 #endif /* HAVE_LIBSTATGRAB */
  91
  92 static int swap_init (void)
  93 {
  94 #if KERNEL_LINUX
  95         /* No init stuff */
  96 /* #endif KERNEL_LINUX */
  97
  98 #elif HAVE_LIBKSTAT
  99         /* getpagesize(3C) tells me this does not fail.. */
 100         pagesize = (unsigned long long) getpagesize ();
 101         if (get_kstat (&ksp, "unix", 0, "system_pages"))
 102                 ksp = NULL;
 103 /* #endif HAVE_LIBKSTAT */
 104
 105 #elif HAVE_SWAPCTL
 106         /* No init stuff */
 107 /* #endif HAVE_SWAPCTL */
 108
 109 #elif defined(VM_SWAPUSAGE)
 110         /* No init stuff */
 111 /* #endif defined(VM_SWAPUSAGE) */
 112
 113 #elif HAVE_LIBKVM_GETSWAPINFO
 114         if (kvm_obj != NULL)
 115         {
 116                 kvm_close (kvm_obj);
 117                 kvm_obj = NULL;
 118         }
 119
 120         kvm_pagesize = getpagesize ();
 121
 122         if ((kvm_obj = kvm_open (NULL, /* execfile */
 123                                         NULL, /* corefile */
 124                                         NULL, /* swapfile */
 125                                         O_RDONLY, /* flags */
 126                                         NULL)) /* errstr */
 127                         == NULL)
 128         {
 129                 ERROR ("swap plugin: kvm_open failed.");
 130                 return (-1);
 131         }
 132 /* #endif HAVE_LIBKVM_GETSWAPINFO */
 133
 134 #elif HAVE_LIBSTATGRAB
 135         /* No init stuff */
 136 #endif /* HAVE_LIBSTATGRAB */
 137
 138         return (0);
 139 }
 140
 141 static void swap_submit (const char *type_instance, derive_t value, unsigned type)
 142 {
 143         value_t values[1];
 144         value_list_t vl = VALUE_LIST_INIT;
 145
 146         switch (type)
 147         {
 148                 case DS_TYPE_GAUGE:
 149                         values[0].gauge = value;
 150                         sstrncpy (vl.type, "swap", sizeof (vl.type));
 151                         break;
 152                 case DS_TYPE_DERIVE:
 153                         values[0].derive = value;
 154                         sstrncpy (vl.type, "swap_io", sizeof (vl.type));
 155                         break;
 156                 default:
 157                         ERROR ("swap plugin: swap_submit called with wrong"
 158                                 " type");
 159         }
 160
 161         vl.values = values;
 162         vl.values_len = 1;
 163         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 164         sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
 165         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 166
 167         plugin_dispatch_values (&vl);
 168 } /* void swap_submit */
 169
 170 static int swap_read (void)
 171 {
 172 #if KERNEL_LINUX
 173         FILE *fh;
 174         char buffer[1024];
 175
 176         char *fields[8];
 177         int numfields;
 178
 179         unsigned long long swap_used   = 0LL;
 180         unsigned long long swap_cached = 0LL;
 181         unsigned long long swap_free   = 0LL;
 182         unsigned long long swap_total  = 0LL;
 183         unsigned long long swap_in     = 0LL;
 184         unsigned long long swap_out    = 0LL;
 185
 186         if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
 187         {
 188                 char errbuf[1024];
 189                 WARNING ("memory: fopen: %s",
 190                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 191                 return (-1);
 192         }
 193
 194         while (fgets (buffer, 1024, fh) != NULL)
 195         {
 196                 unsigned long long *val = NULL;
 197
 198                 if (strncasecmp (buffer, "SwapTotal:", 10) == 0)
 199                         val = &swap_total;
 200                 else if (strncasecmp (buffer, "SwapFree:", 9) == 0)
 201                         val = &swap_free;
 202                 else if (strncasecmp (buffer, "SwapCached:", 11) == 0)
 203                         val = &swap_cached;
 204                 else
 205                         continue;
 206
 207                 numfields = strsplit (buffer, fields, 8);
 208
 209                 if (numfields < 2)
 210                         continue;
 211
 212                 *val = atoll (fields[1]) * 1024LL;
 213         }
 214
 215         if (fclose (fh))
 216         {
 217                 char errbuf[1024];
 218                 WARNING ("memory: fclose: %s",
 219                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 220         }
 221
 222         if ((swap_total == 0LL) || ((swap_free + swap_cached) > swap_total))
 223                 return (-1);
 224
 225         swap_used = swap_total - (swap_free + swap_cached);
 226
 227         if ((fh = fopen ("/proc/vmstat", "r")) == NULL)
 228         {
 229                 char errbuf[1024];
 230                 WARNING ("swap: fopen: %s",
 231                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 232                 return (-1);
 233         }
 234
 235         while (fgets (buffer, 1024, fh) != NULL)
 236         {
 237                 unsigned long long *val = NULL;
 238
 239                 if (strncasecmp (buffer, "pswpin", 6) == 0)
 240                         val = &swap_in;
 241                 else if (strncasecmp (buffer, "pswpout", 7) == 0)
 242                         val = &swap_out;
 243                 else
 244                         continue;
 245
 246                 numfields = strsplit (buffer, fields, 8);
 247
 248                 if (numfields < 2)
 249                         continue;
 250
 251                 *val = atoll (fields[1]);
 252         }
 253
 254         if (fclose (fh))
 255         {
 256                 char errbuf[1024];
 257                 WARNING ("swap: fclose: %s",
 258                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 259         }
 260
 261         swap_submit ("used", swap_used, DS_TYPE_GAUGE);
 262         swap_submit ("free", swap_free, DS_TYPE_GAUGE);
 263         swap_submit ("cached", swap_cached, DS_TYPE_GAUGE);
 264         swap_submit ("in", swap_in, DS_TYPE_DERIVE);
 265         swap_submit ("out", swap_out, DS_TYPE_DERIVE);
 266
 267 /* #endif KERNEL_LINUX */
 268
 269 #elif HAVE_LIBKSTAT
 270         unsigned long long swap_alloc;
 271         unsigned long long swap_resv;
 272         unsigned long long swap_avail;
 273
 274         struct anoninfo ai;
 275
 276         if (swapctl (SC_AINFO, &ai) == -1)
 277         {
 278                 char errbuf[1024];
 279                 ERROR ("swap plugin: swapctl failed: %s",
 280                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 281                 return (-1);
 282         }
 283
 284         /*
 285          * Calculations from:
 286          * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
 287          * Also see:
 288          * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
 289          * /usr/include/vm/anon.h
 290          *
 291          * In short, swap -s shows: allocated + reserved = used, available
 292          *
 293          * However, Solaris does not allow to allocated/reserved more than the
 294          * available swap (physical memory + disk swap), so the pedant may
 295          * prefer: allocated + unallocated = reserved, available
 296          *
 297          * We map the above to: used + resv = n/a, free
 298          *
 299          * Does your brain hurt yet?  - Christophe Kalt
 300          *
 301          * Oh, and in case you wonder,
 302          * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
 303          * can suffer from a 32bit overflow.
 304          */
 305         swap_alloc  = ai.ani_max - ai.ani_free;
 306         swap_alloc *= pagesize;
 307         swap_resv   = ai.ani_resv + ai.ani_free - ai.ani_max;
 308         swap_resv  *= pagesize;
 309         swap_avail  = ai.ani_max - ai.ani_resv;
 310         swap_avail *= pagesize;
 311
 312         swap_submit ("used", swap_alloc);
 313         swap_submit ("free", swap_avail);
 314         swap_submit ("reserved", swap_resv);
 315 /* #endif HAVE_LIBKSTAT */
 316
 317 #elif HAVE_SWAPCTL
 318         struct swapent *swap_entries;
 319         int swap_num;
 320         int status;
 321         int i;
 322
 323         uint64_t used  = 0;
 324         uint64_t total = 0;
 325
 326         /*
 327          * XXX: This is the syntax for the *BSD `swapctl', which has the
 328          * following prototype:
 329          *   swapctl (int cmd, void *arg, int misc);
 330          *
 331          * HP-UX and Solaris (and possibly other UNIXes) provide `swapctl',
 332          * too, but with the following prototype:
 333          *   swapctl (int cmd, void *arg);
 334          *
 335          * Solaris is usually handled in the KSTAT case above. For other UNIXes
 336          * a separate case for the other version of `swapctl' may be necessary.
 337          */
 338         swap_num = swapctl (SWAP_NSWAP, NULL, 0);
 339         if (swap_num < 0)
 340         {
 341                 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
 342                                 swap_num);
 343                 return (-1);
 344         }
 345         else if (swap_num == 0)
 346                 return (0);
 347
 348         swap_entries = calloc (swap_num, sizeof (*swap_entries));
 349         if (swap_entries == NULL)
 350         {
 351                 ERROR ("swap plugin: calloc failed.");
 352                 return (-1);
 353         }
 354
 355         status = swapctl (SWAP_STATS, swap_entries, swap_num);
 356         if (status != swap_num)
 357         {
 358                 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
 359                                 status);
 360                 sfree (swap_entries);
 361                 return (-1);
 362         }
 363
 364 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
 365 # define C_SWAP_BLOCK_SIZE ((uint64_t) DEV_BSIZE)
 366 #else
 367 # define C_SWAP_BLOCK_SIZE ((uint64_t) 512)
 368 #endif
 369
 370         for (i = 0; i < swap_num; i++)
 371         {
 372                 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
 373                         continue;
 374
 375                 used  += ((uint64_t) swap_entries[i].se_inuse)
 376                         * C_SWAP_BLOCK_SIZE;
 377                 total += ((uint64_t) swap_entries[i].se_nblks)
 378                         * C_SWAP_BLOCK_SIZE;
 379         }
 380
 381         if (total < used)
 382         {
 383                 ERROR ("swap plugin: Total swap space (%"PRIu64") "
 384                                 "is less than used swap space (%"PRIu64").",
 385                                 total, used);
 386                 return (-1);
 387         }
 388
 389         swap_submit ("used", (gauge_t) used);
 390         swap_submit ("free", (gauge_t) (total - used));
 391
 392         sfree (swap_entries);
 393 /* #endif HAVE_SWAPCTL */
 394
 395 #elif defined(VM_SWAPUSAGE)
 396         int              mib[3];
 397         size_t           mib_len;
 398         struct xsw_usage sw_usage;
 399         size_t           sw_usage_len;
 400
 401         mib_len = 2;
 402         mib[0]  = CTL_VM;
 403         mib[1]  = VM_SWAPUSAGE;
 404
 405         sw_usage_len = sizeof (struct xsw_usage);
 406
 407         if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
 408                 return (-1);
 409
 410         /* The returned values are bytes. */
 411         swap_submit ("used", sw_usage.xsu_used);
 412         swap_submit ("free", sw_usage.xsu_avail);
 413 /* #endif VM_SWAPUSAGE */
 414
 415 #elif HAVE_LIBKVM_GETSWAPINFO
 416         struct kvm_swap data_s;
 417         int             status;
 418
 419         unsigned long long used;
 420         unsigned long long free;
 421         unsigned long long total;
 422
 423         if (kvm_obj == NULL)
 424                 return (-1);
 425
 426         /* only one structure => only get the grand total, no details */
 427         status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
 428         if (status == -1)
 429                 return (-1);
 430
 431         total = (unsigned long long) data_s.ksw_total;
 432         used  = (unsigned long long) data_s.ksw_used;
 433
 434         total *= (unsigned long long) kvm_pagesize;
 435         used  *= (unsigned long long) kvm_pagesize;
 436
 437         free = total - used;
 438
 439         swap_submit ("used", used);
 440         swap_submit ("free", free);
 441 /* #endif HAVE_LIBKVM_GETSWAPINFO */
 442
 443 #elif HAVE_LIBSTATGRAB
 444         sg_swap_stats *swap;
 445
 446         swap = sg_get_swap_stats ();
 447
 448         if (swap == NULL)
 449                 return (-1);
 450
 451         swap_submit ("used", swap->used);
 452         swap_submit ("free", swap->free);
 453 #endif /* HAVE_LIBSTATGRAB */
 454
 455         return (0);
 456 } /* int swap_read */
 457
 458 void module_register (void)
 459 {
 460         plugin_register_init ("swap", swap_init);
 461         plugin_register_read ("swap", swap_read);
 462 } /* void module_register */