src/swap.c

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