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         _Bool old_kernel=0;
 197
 198         derive_t swap_used   = 0;
 199         derive_t swap_cached = 0;
 200         derive_t swap_free   = 0;
 201         derive_t swap_total  = 0;
 202         derive_t swap_in     = 0;
 203         derive_t swap_out    = 0;
 204
 205         if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
 206         {
 207                 char errbuf[1024];
 208                 WARNING ("memory: fopen: %s",
 209                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 210                 return (-1);
 211         }
 212
 213         while (fgets (buffer, sizeof (buffer), fh) != NULL)
 214         {
 215                 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
 216                 if (numfields < 2)
 217                         continue;
 218
 219                 if (strcasecmp (fields[0], "SwapTotal:") == 0)
 220                         strtoderive (fields[1], &swap_total);
 221                 else if (strcasecmp (fields[0], "SwapFree:") == 0)
 222                         strtoderive (fields[1], &swap_free);
 223                 else if (strcasecmp (fields[0], "SwapCached:") == 0)
 224                         strtoderive (fields[1], &swap_cached);
 225         }
 226
 227         if (fclose (fh))
 228         {
 229                 char errbuf[1024];
 230                 WARNING ("memory: fclose: %s",
 231                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 232         }
 233
 234         if ((swap_total == 0LL) || ((swap_free + swap_cached) > swap_total))
 235                 return (-1);
 236
 237         swap_used = swap_total - (swap_free + swap_cached);
 238
 239         if ((fh = fopen ("/proc/vmstat", "r")) == NULL)
 240         {
 241                 // /proc/vmstat does not exist in kernels <2.6
 242                 if ((fh = fopen ("/proc/stat", "r")) == NULL )
 243                 {
 244                         char errbuf[1024];
 245                         WARNING ("swap: fopen: %s",
 246                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 247                         return (-1);
 248                 }
 249                 else
 250                         old_kernel = 1;
 251         }
 252
 253         while (fgets (buffer, sizeof (buffer), fh) != NULL)
 254         {
 255                 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
 256
 257                 if (!old_kernel)
 258                 {
 259                         if (numfields != 2)
 260                                 continue;
 261
 262                         if (strcasecmp ("pswpin", fields[0]) == 0)
 263                                 strtoderive (fields[1], &swap_in);
 264                         else if (strcasecmp ("pswpout", fields[0]) == 0)
 265                                 strtoderive (fields[1], &swap_out);
 266                 }
 267                 else /* if (old_kernel) */
 268                 {
 269                         if (numfields != 3)
 270                                 continue;
 271
 272                         if (strcasecmp ("page", fields[0]) == 0)
 273                         {
 274                                 strtoderive (fields[1], &swap_in);
 275                                 strtoderive (fields[2], &swap_out);
 276                         }
 277                 }
 278         } /* while (fgets) */
 279
 280         if (fclose (fh))
 281         {
 282                 char errbuf[1024];
 283                 WARNING ("swap: fclose: %s",
 284                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 285         }
 286
 287         swap_submit ("used",   1024 * swap_used,   DS_TYPE_GAUGE);
 288         swap_submit ("free",   1024 * swap_free,   DS_TYPE_GAUGE);
 289         swap_submit ("cached", 1024 * swap_cached, DS_TYPE_GAUGE);
 290         swap_submit ("in",  swap_in,  DS_TYPE_DERIVE);
 291         swap_submit ("out", swap_out, DS_TYPE_DERIVE);
 292 /* #endif KERNEL_LINUX */
 293
 294 #elif HAVE_LIBKSTAT
 295         derive_t swap_alloc;
 296         derive_t swap_resv;
 297         derive_t swap_avail;
 298
 299         struct anoninfo ai;
 300
 301         if (swapctl (SC_AINFO, &ai) == -1)
 302         {
 303                 char errbuf[1024];
 304                 ERROR ("swap plugin: swapctl failed: %s",
 305                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 306                 return (-1);
 307         }
 308
 309         /*
 310          * Calculations from:
 311          * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
 312          * Also see:
 313          * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
 314          * /usr/include/vm/anon.h
 315          *
 316          * In short, swap -s shows: allocated + reserved = used, available
 317          *
 318          * However, Solaris does not allow to allocated/reserved more than the
 319          * available swap (physical memory + disk swap), so the pedant may
 320          * prefer: allocated + unallocated = reserved, available
 321          *
 322          * We map the above to: used + resv = n/a, free
 323          *
 324          * Does your brain hurt yet?  - Christophe Kalt
 325          *
 326          * Oh, and in case you wonder,
 327          * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
 328          * can suffer from a 32bit overflow.
 329          */
 330         swap_alloc  = (derive_t) ((ai.ani_max - ai.ani_free) * pagesize);
 331         swap_resv   = (derive_t) ((ai.ani_resv + ai.ani_free - ai.ani_max)
 332                         * pagesize);
 333         swap_avail  = (derive_t) ((ai.ani_max - ai.ani_resv) * pagesize);
 334
 335         swap_submit ("used", swap_alloc, DS_TYPE_GAUGE);
 336         swap_submit ("free", swap_avail, DS_TYPE_GAUGE);
 337         swap_submit ("reserved", swap_resv, DS_TYPE_GAUGE);
 338 /* #endif HAVE_LIBKSTAT */
 339
 340 #elif HAVE_SWAPCTL
 341         struct swapent *swap_entries;
 342         int swap_num;
 343         int status;
 344         int i;
 345
 346         derive_t used  = 0;
 347         derive_t total = 0;
 348
 349         /*
 350          * XXX: This is the syntax for the *BSD `swapctl', which has the
 351          * following prototype:
 352          *   swapctl (int cmd, void *arg, int misc);
 353          *
 354          * HP-UX and Solaris (and possibly other UNIXes) provide `swapctl',
 355          * too, but with the following prototype:
 356          *   swapctl (int cmd, void *arg);
 357          *
 358          * Solaris is usually handled in the KSTAT case above. For other UNIXes
 359          * a separate case for the other version of `swapctl' may be necessary.
 360          */
 361         swap_num = swapctl (SWAP_NSWAP, NULL, 0);
 362         if (swap_num < 0)
 363         {
 364                 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
 365                                 swap_num);
 366                 return (-1);
 367         }
 368         else if (swap_num == 0)
 369                 return (0);
 370
 371         swap_entries = calloc (swap_num, sizeof (*swap_entries));
 372         if (swap_entries == NULL)
 373         {
 374                 ERROR ("swap plugin: calloc failed.");
 375                 return (-1);
 376         }
 377
 378         status = swapctl (SWAP_STATS, swap_entries, swap_num);
 379         if (status != swap_num)
 380         {
 381                 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
 382                                 status);
 383                 sfree (swap_entries);
 384                 return (-1);
 385         }
 386
 387 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
 388 # define C_SWAP_BLOCK_SIZE ((derive_t) DEV_BSIZE)
 389 #else
 390 # define C_SWAP_BLOCK_SIZE ((derive_t) 512)
 391 #endif
 392
 393         for (i = 0; i < swap_num; i++)
 394         {
 395                 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
 396                         continue;
 397
 398                 used  += ((derive_t) swap_entries[i].se_inuse)
 399                         * C_SWAP_BLOCK_SIZE;
 400                 total += ((derive_t) swap_entries[i].se_nblks)
 401                         * C_SWAP_BLOCK_SIZE;
 402         }
 403
 404         if (total < used)
 405         {
 406                 ERROR ("swap plugin: Total swap space (%"PRIu64") "
 407                                 "is less than used swap space (%"PRIu64").",
 408                                 total, used);
 409                 return (-1);
 410         }
 411
 412         swap_submit ("used", used, DS_TYPE_GAUGE);
 413         swap_submit ("free", total - used, DS_TYPE_GAUGE);
 414
 415         sfree (swap_entries);
 416 /* #endif HAVE_SWAPCTL */
 417
 418 #elif defined(VM_SWAPUSAGE)
 419         int              mib[3];
 420         size_t           mib_len;
 421         struct xsw_usage sw_usage;
 422         size_t           sw_usage_len;
 423
 424         mib_len = 2;
 425         mib[0]  = CTL_VM;
 426         mib[1]  = VM_SWAPUSAGE;
 427
 428         sw_usage_len = sizeof (struct xsw_usage);
 429
 430         if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
 431                 return (-1);
 432
 433         /* The returned values are bytes. */
 434         swap_submit ("used", (derive_t) sw_usage.xsu_used, DS_TYPE_GAUGE);
 435         swap_submit ("free", (derive_t) sw_usage.xsu_avail, DS_TYPE_GAUGE);
 436 /* #endif VM_SWAPUSAGE */
 437
 438 #elif HAVE_LIBKVM_GETSWAPINFO
 439         struct kvm_swap data_s;
 440         int             status;
 441
 442         derive_t used;
 443         derive_t free;
 444         derive_t total;
 445
 446         if (kvm_obj == NULL)
 447                 return (-1);
 448
 449         /* only one structure => only get the grand total, no details */
 450         status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
 451         if (status == -1)
 452                 return (-1);
 453
 454         total = (derive_t) data_s.ksw_total;
 455         used  = (derive_t) data_s.ksw_used;
 456
 457         total *= (derive_t) kvm_pagesize;
 458         used  *= (derive_t) kvm_pagesize;
 459
 460         free = total - used;
 461
 462         swap_submit ("used", used, DS_TYPE_GAUGE);
 463         swap_submit ("free", free, DS_TYPE_GAUGE);
 464 /* #endif HAVE_LIBKVM_GETSWAPINFO */
 465
 466 #elif HAVE_LIBSTATGRAB
 467         sg_swap_stats *swap;
 468
 469         swap = sg_get_swap_stats ();
 470
 471         if (swap == NULL)
 472                 return (-1);
 473
 474         swap_submit ("used", (derive_t) swap->used, DS_TYPE_GAUGE);
 475         swap_submit ("free", (derive_t) swap->free, DS_TYPE_GAUGE);
 476 /* #endif  HAVE_LIBSTATGRAB */
 477
 478 #elif HAVE_PERFSTAT
 479         if(perfstat_memory_total(NULL, &pmemory, sizeof(perfstat_memory_total_t), 1) < 0)
 480         {
 481                 char errbuf[1024];
 482                 WARNING ("memory plugin: perfstat_memory_total failed: %s",
 483                         sstrerror (errno, errbuf, sizeof (errbuf)));
 484                 return (-1);
 485         }
 486         swap_submit ("used", (derive_t) (pmemory.pgsp_total - pmemory.pgsp_free) * pagesize, DS_TYPE_GAUGE);
 487         swap_submit ("free", (derive_t) pmemory.pgsp_free * pagesize , DS_TYPE_GAUGE);
 488 #endif /* HAVE_PERFSTAT */
 489
 490         return (0);
 491 } /* int swap_read */
 492
 493 void module_register (void)
 494 {
 495         plugin_register_init ("swap", swap_init);
 496         plugin_register_read ("swap", swap_read);
 497 } /* void module_register */