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
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.
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.
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
21 * Florian octo Forster <octo at verplant.org>
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
40 # include <sys/swap.h>
46 # include <sys/param.h>
49 # include <sys/sysctl.h>
52 # include <sys/dkstat.h>
59 # include <statgrab.h>
63 # include <sys/protosw.h>
64 # include <libperfstat.h>
68 #define MAX(x,y) ((x) > (y) ? (x) : (y))
71 /* No global variables */
72 /* #endif KERNEL_LINUX */
75 static derive_t pagesize;
77 /* #endif HAVE_LIBKSTAT */
80 /* No global variables */
81 /* #endif HAVE_SWAPCTL */
83 #elif defined(VM_SWAPUSAGE)
84 /* No global variables */
85 /* #endif defined(VM_SWAPUSAGE) */
87 #elif HAVE_LIBKVM_GETSWAPINFO
88 static kvm_t *kvm_obj = NULL;
90 /* #endif HAVE_LIBKVM_GETSWAPINFO */
92 #elif HAVE_LIBSTATGRAB
93 /* No global variables */
94 /* #endif HAVE_LIBSTATGRAB */
98 static perfstat_memory_total_t pmemory;
99 /*# endif HAVE_PERFSTAT */
102 # error "No applicable input method."
103 #endif /* HAVE_LIBSTATGRAB */
105 static int swap_init (void)
109 /* #endif KERNEL_LINUX */
112 /* getpagesize(3C) tells me this does not fail.. */
113 pagesize = (derive_t) getpagesize ();
114 if (get_kstat (&ksp, "unix", 0, "system_pages"))
116 /* #endif HAVE_LIBKSTAT */
120 /* #endif HAVE_SWAPCTL */
122 #elif defined(VM_SWAPUSAGE)
124 /* #endif defined(VM_SWAPUSAGE) */
126 #elif HAVE_LIBKVM_GETSWAPINFO
133 kvm_pagesize = getpagesize ();
135 if ((kvm_obj = kvm_open (NULL, /* execfile */
138 O_RDONLY, /* flags */
142 ERROR ("swap plugin: kvm_open failed.");
145 /* #endif HAVE_LIBKVM_GETSWAPINFO */
147 #elif HAVE_LIBSTATGRAB
149 /* #endif HAVE_LIBSTATGRAB */
152 pagesize = getpagesize();
153 #endif /* HAVE_PERFSTAT */
158 static void swap_submit (const char *type_instance, derive_t value, unsigned type)
161 value_list_t vl = VALUE_LIST_INIT;
166 values[0].gauge = (gauge_t) value;
167 sstrncpy (vl.type, "swap", sizeof (vl.type));
170 values[0].derive = value;
171 sstrncpy (vl.type, "swap_io", sizeof (vl.type));
174 ERROR ("swap plugin: swap_submit called with wrong"
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));
184 plugin_dispatch_values (&vl);
185 } /* void swap_submit */
187 static int swap_read (void)
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;
205 if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
208 WARNING ("memory: fopen: %s",
209 sstrerror (errno, errbuf, sizeof (errbuf)));
213 while (fgets (buffer, sizeof (buffer), fh) != NULL)
215 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
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);
230 WARNING ("memory: fclose: %s",
231 sstrerror (errno, errbuf, sizeof (errbuf)));
234 if ((swap_total == 0LL) || ((swap_free + swap_cached) > swap_total))
237 swap_used = swap_total - (swap_free + swap_cached);
239 if ((fh = fopen ("/proc/vmstat", "r")) == NULL)
241 // /proc/vmstat does not exist in kernels <2.6
242 if ((fh = fopen ("/proc/stat", "r")) == NULL )
245 WARNING ("swap: fopen: %s",
246 sstrerror (errno, errbuf, sizeof (errbuf)));
253 while (fgets (buffer, sizeof (buffer), fh) != NULL)
255 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
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);
267 else /* if (old_kernel) */
272 if (strcasecmp ("page", fields[0]) == 0)
274 strtoderive (fields[1], &swap_in);
275 strtoderive (fields[2], &swap_out);
278 } /* while (fgets) */
283 WARNING ("swap: fclose: %s",
284 sstrerror (errno, errbuf, sizeof (errbuf)));
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 */
301 if (swapctl (SC_AINFO, &ai) == -1)
304 ERROR ("swap plugin: swapctl failed: %s",
305 sstrerror (errno, errbuf, sizeof (errbuf)));
311 * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
313 * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
314 * /usr/include/vm/anon.h
316 * In short, swap -s shows: allocated + reserved = used, available
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
322 * We map the above to: used + resv = n/a, free
324 * Does your brain hurt yet? - Christophe Kalt
326 * Oh, and in case you wonder,
327 * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
328 * can suffer from a 32bit overflow.
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)
333 swap_avail = (derive_t) ((ai.ani_max - ai.ani_resv) * pagesize);
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 */
341 struct swapent *swap_entries;
350 * XXX: This is the syntax for the *BSD `swapctl', which has the
351 * following prototype:
352 * swapctl (int cmd, void *arg, int misc);
354 * HP-UX and Solaris (and possibly other UNIXes) provide `swapctl',
355 * too, but with the following prototype:
356 * swapctl (int cmd, void *arg);
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.
361 swap_num = swapctl (SWAP_NSWAP, NULL, 0);
364 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
368 else if (swap_num == 0)
371 swap_entries = calloc (swap_num, sizeof (*swap_entries));
372 if (swap_entries == NULL)
374 ERROR ("swap plugin: calloc failed.");
378 status = swapctl (SWAP_STATS, swap_entries, swap_num);
379 if (status != swap_num)
381 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
383 sfree (swap_entries);
387 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
388 # define C_SWAP_BLOCK_SIZE ((derive_t) DEV_BSIZE)
390 # define C_SWAP_BLOCK_SIZE ((derive_t) 512)
393 for (i = 0; i < swap_num; i++)
395 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
398 used += ((derive_t) swap_entries[i].se_inuse)
400 total += ((derive_t) swap_entries[i].se_nblks)
406 ERROR ("swap plugin: Total swap space (%"PRIu64") "
407 "is less than used swap space (%"PRIu64").",
412 swap_submit ("used", used, DS_TYPE_GAUGE);
413 swap_submit ("free", total - used, DS_TYPE_GAUGE);
415 sfree (swap_entries);
416 /* #endif HAVE_SWAPCTL */
418 #elif defined(VM_SWAPUSAGE)
421 struct xsw_usage sw_usage;
426 mib[1] = VM_SWAPUSAGE;
428 sw_usage_len = sizeof (struct xsw_usage);
430 if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
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 */
438 #elif HAVE_LIBKVM_GETSWAPINFO
439 struct kvm_swap data_s;
449 /* only one structure => only get the grand total, no details */
450 status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
454 total = (derive_t) data_s.ksw_total;
455 used = (derive_t) data_s.ksw_used;
457 total *= (derive_t) kvm_pagesize;
458 used *= (derive_t) kvm_pagesize;
462 swap_submit ("used", used, DS_TYPE_GAUGE);
463 swap_submit ("free", free, DS_TYPE_GAUGE);
464 /* #endif HAVE_LIBKVM_GETSWAPINFO */
466 #elif HAVE_LIBSTATGRAB
469 swap = sg_get_swap_stats ();
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 */
479 if(perfstat_memory_total(NULL, &pmemory, sizeof(perfstat_memory_total_t), 1) < 0)
482 WARNING ("memory plugin: perfstat_memory_total failed: %s",
483 sstrerror (errno, errbuf, sizeof (errbuf)));
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 */
491 } /* int swap_read */
493 void module_register (void)
495 plugin_register_init ("swap", swap_init);
496 plugin_register_read ("swap", swap_read);
497 } /* void module_register */