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