2 * collectd - src/swap.c
3 * Copyright (C) 2005-2014 Florian octo Forster
4 * Copyright (C) 2009 Stefan Völkel
5 * Copyright (C) 2009 Manuel Sanmartin
6 * Copyright (C) 2010 Aurélien Reynaud
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Florian octo Forster <octo at collectd.org>
24 * Aurélien Reynaud <collectd at wattapower.net>
31 /* avoid swap.h error "Cannot use swapctl in the large files compilation environment" */
32 #if HAVE_SYS_SWAP_H && !defined(_LP64) && _FILE_OFFSET_BITS == 64
33 # undef _FILE_OFFSET_BITS
34 # undef _LARGEFILE64_SOURCE
42 # include <sys/swap.h>
48 # include <sys/param.h>
51 # include <sys/sysctl.h>
54 # include <sys/dkstat.h>
61 # include <statgrab.h>
65 # include <sys/protosw.h>
66 # include <libperfstat.h>
70 #define MAX(x,y) ((x) > (y) ? (x) : (y))
73 # define SWAP_HAVE_REPORT_BY_DEVICE 1
74 static derive_t pagesize;
75 static _Bool report_bytes = 0;
76 static _Bool report_by_device = 0;
77 /* #endif KERNEL_LINUX */
79 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
80 # define SWAP_HAVE_REPORT_BY_DEVICE 1
81 static derive_t pagesize;
82 static _Bool report_by_device = 0;
83 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
85 #elif defined(VM_SWAPUSAGE)
86 /* No global variables */
87 /* #endif defined(VM_SWAPUSAGE) */
89 #elif HAVE_LIBKVM_GETSWAPINFO
90 static kvm_t *kvm_obj = NULL;
92 /* #endif HAVE_LIBKVM_GETSWAPINFO */
94 #elif HAVE_LIBSTATGRAB
95 /* No global variables */
96 /* #endif HAVE_LIBSTATGRAB */
100 /*# endif HAVE_PERFSTAT */
103 # error "No applicable input method."
104 #endif /* HAVE_LIBSTATGRAB */
106 static _Bool values_absolute = 1;
107 static _Bool values_percentage = 0;
109 static int swap_config (oconfig_item_t *ci) /* {{{ */
113 for (i = 0; i < ci->children_num; i++)
115 oconfig_item_t *child = ci->children + i;
116 if (strcasecmp ("ReportBytes", child->key) == 0)
118 cf_util_get_boolean (child, &report_bytes);
120 WARNING ("swap plugin: The \"ReportBytes\" option "
121 "is only valid under Linux. "
122 "The option is going to be ignored.");
124 else if (strcasecmp ("ReportByDevice", child->key) == 0)
125 #if SWAP_HAVE_REPORT_BY_DEVICE
126 cf_util_get_boolean (child, &report_by_device);
128 WARNING ("swap plugin: The \"ReportByDevice\" option "
129 "is not supported on this platform. "
130 "The option is going to be ignored.");
131 #endif /* SWAP_HAVE_REPORT_BY_DEVICE */
132 else if (strcasecmp ("ValuesAbsolute", child->key) == 0)
133 cf_util_get_boolean (child, &values_absolute);
134 else if (strcasecmp ("ValuesPercentage", child->key) == 0)
135 cf_util_get_boolean (child, &values_percentage);
137 WARNING ("swap plugin: Unknown config option: \"%s\"",
142 } /* }}} int swap_config */
144 static int swap_init (void) /* {{{ */
147 pagesize = (derive_t) sysconf (_SC_PAGESIZE);
148 /* #endif KERNEL_LINUX */
150 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
151 /* getpagesize(3C) tells me this does not fail.. */
152 pagesize = (derive_t) getpagesize ();
153 /* #endif HAVE_SWAPCTL */
155 #elif defined(VM_SWAPUSAGE)
157 /* #endif defined(VM_SWAPUSAGE) */
159 #elif HAVE_LIBKVM_GETSWAPINFO
166 kvm_pagesize = getpagesize ();
168 if ((kvm_obj = kvm_open (NULL, /* execfile */
171 O_RDONLY, /* flags */
175 ERROR ("swap plugin: kvm_open failed.");
178 /* #endif HAVE_LIBKVM_GETSWAPINFO */
180 #elif HAVE_LIBSTATGRAB
182 /* #endif HAVE_LIBSTATGRAB */
185 pagesize = getpagesize();
186 #endif /* HAVE_PERFSTAT */
189 } /* }}} int swap_init */
191 static void swap_submit (const char *plugin_instance, /* {{{ */
192 const char *type, const char *type_instance,
195 value_list_t vl = VALUE_LIST_INIT;
197 assert (type != NULL);
201 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
202 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
203 if (plugin_instance != NULL)
204 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
205 sstrncpy (vl.type, type, sizeof (vl.type));
206 if (type_instance != NULL)
207 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
209 plugin_dispatch_values (&vl);
210 } /* }}} void swap_submit_inst */
212 static void swap_submit_usage (char const *plugin_instance, /* {{{ */
213 gauge_t used, gauge_t free,
214 char const *other_name, gauge_t other_value)
217 value_list_t vl = VALUE_LIST_INIT;
220 vl.values_len = STATIC_ARRAY_SIZE (v);
221 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
222 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
223 if (plugin_instance != NULL)
224 sstrncpy (vl.plugin_instance, plugin_instance,
225 sizeof (vl.plugin_instance));
226 sstrncpy (vl.type, "swap", sizeof (vl.type));
229 plugin_dispatch_multivalue (&vl, 0,
230 "used", used, "free", free,
231 other_name, other_value, NULL);
232 if (values_percentage)
233 plugin_dispatch_multivalue (&vl, 1,
234 "used", used, "free", free,
235 other_name, other_value, NULL);
236 } /* }}} void swap_submit_usage */
238 #if KERNEL_LINUX || HAVE_PERFSTAT
239 static void swap_submit_derive (const char *plugin_instance, /* {{{ */
240 const char *type_instance, derive_t value)
245 swap_submit (plugin_instance, "swap_io", type_instance, v);
246 } /* }}} void swap_submit_derive */
250 static int swap_read_separate (void) /* {{{ */
255 fh = fopen ("/proc/swaps", "r");
259 WARNING ("swap plugin: fopen (/proc/swaps) failed: %s",
260 sstrerror (errno, errbuf, sizeof (errbuf)));
264 while (fgets (buffer, sizeof (buffer), fh) != NULL)
274 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
278 sstrncpy (path, fields[0], sizeof (path));
279 escape_slashes (path, sizeof (path));
283 total = strtod (fields[2], &endptr);
284 if ((endptr == fields[2]) || (errno != 0))
289 used = strtod (fields[3], &endptr);
290 if ((endptr == fields[3]) || (errno != 0))
296 swap_submit_usage (path, used, total - used, NULL, NAN);
302 } /* }}} int swap_read_separate */
304 static int swap_read_combined (void) /* {{{ */
309 uint8_t have_data = 0;
310 gauge_t swap_used = 0.0;
311 gauge_t swap_cached = 0.0;
312 gauge_t swap_free = 0.0;
313 gauge_t swap_total = 0.0;
315 fh = fopen ("/proc/meminfo", "r");
319 WARNING ("swap plugin: fopen (/proc/meminfo) failed: %s",
320 sstrerror (errno, errbuf, sizeof (errbuf)));
324 while (fgets (buffer, sizeof (buffer), fh) != NULL)
329 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
333 if (strcasecmp (fields[0], "SwapTotal:") == 0)
335 swap_total = strtod (fields[1], /* endptr = */ NULL);
338 else if (strcasecmp (fields[0], "SwapFree:") == 0)
340 swap_free = strtod (fields[1], /* endptr = */ NULL);
343 else if (strcasecmp (fields[0], "SwapCached:") == 0)
345 swap_cached = strtod (fields[1], /* endptr = */ NULL);
352 if (have_data != 0x07)
355 if (isnan (swap_total)
356 || (swap_total <= 0.0)
357 || ((swap_free + swap_cached) > swap_total))
360 swap_used = swap_total - (swap_free + swap_cached);
362 swap_submit_usage (NULL, swap_used, swap_free, "cached", swap_cached);
364 } /* }}} int swap_read_combined */
366 static int swap_read_io (void) /* {{{ */
371 _Bool old_kernel = 0;
373 uint8_t have_data = 0;
374 derive_t swap_in = 0;
375 derive_t swap_out = 0;
377 fh = fopen ("/proc/vmstat", "r");
380 /* /proc/vmstat does not exist in kernels <2.6 */
381 fh = fopen ("/proc/stat", "r");
385 WARNING ("swap: fopen: %s",
386 sstrerror (errno, errbuf, sizeof (errbuf)));
393 while (fgets (buffer, sizeof (buffer), fh) != NULL)
398 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
405 if (strcasecmp ("pswpin", fields[0]) == 0)
407 strtoderive (fields[1], &swap_in);
410 else if (strcasecmp ("pswpout", fields[0]) == 0)
412 strtoderive (fields[1], &swap_out);
416 else /* if (old_kernel) */
421 if (strcasecmp ("page", fields[0]) == 0)
423 strtoderive (fields[1], &swap_in);
424 strtoderive (fields[2], &swap_out);
427 } /* while (fgets) */
431 if (have_data != 0x03)
436 swap_in = swap_in * pagesize;
437 swap_out = swap_out * pagesize;
440 swap_submit_derive (NULL, "in", swap_in);
441 swap_submit_derive (NULL, "out", swap_out);
444 } /* }}} int swap_read_io */
446 static int swap_read (void) /* {{{ */
448 if (report_by_device)
449 swap_read_separate ();
451 swap_read_combined ();
456 } /* }}} int swap_read */
457 /* #endif KERNEL_LINUX */
460 * Under Solaris, two mechanisms can be used to read swap statistics, swapctl
461 * and kstat. The former reads physical space used on a device, the latter
462 * reports the view from the virtual memory system. It was decided that the
463 * kstat-based information should be moved to the "vmem" plugin, but nobody
464 * with enough Solaris experience was available at that time to do this. The
465 * code below is still there for your reference but it won't be activated in
466 * *this* plugin again. --octo
468 #elif 0 && HAVE_LIBKSTAT
469 /* kstat-based read function */
470 static int swap_read_kstat (void) /* {{{ */
478 if (swapctl (SC_AINFO, &ai) == -1)
481 ERROR ("swap plugin: swapctl failed: %s",
482 sstrerror (errno, errbuf, sizeof (errbuf)));
488 * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
490 * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
491 * /usr/include/vm/anon.h
493 * In short, swap -s shows: allocated + reserved = used, available
495 * However, Solaris does not allow to allocated/reserved more than the
496 * available swap (physical memory + disk swap), so the pedant may
497 * prefer: allocated + unallocated = reserved, available
499 * We map the above to: used + resv = n/a, free
501 * Does your brain hurt yet? - Christophe Kalt
503 * Oh, and in case you wonder,
504 * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
505 * can suffer from a 32bit overflow.
507 swap_alloc = (gauge_t) ((ai.ani_max - ai.ani_free) * pagesize);
508 swap_resv = (gauge_t) ((ai.ani_resv + ai.ani_free - ai.ani_max) * pagesize);
509 swap_avail = (gauge_t) ((ai.ani_max - ai.ani_resv) * pagesize);
511 swap_submit_usage (NULL, swap_alloc, swap_avail, "reserved", swap_resv);
513 } /* }}} int swap_read_kstat */
514 /* #endif 0 && HAVE_LIBKSTAT */
516 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
517 /* swapctl-based read function */
518 static int swap_read (void) /* {{{ */
529 swap_num = swapctl (SC_GETNSWP, NULL);
532 ERROR ("swap plugin: swapctl (SC_GETNSWP) failed with status %i.",
536 else if (swap_num == 0)
539 /* Allocate and initialize the swaptbl_t structure */
540 s = (swaptbl_t *) smalloc (swap_num * sizeof (swapent_t) + sizeof (struct swaptable));
543 ERROR ("swap plugin: smalloc failed.");
547 /* Memory to store the path names. We only use these paths when the
548 * separate option has been configured, but it's easier to just
549 * allocate enough memory in any case. */
550 s_paths = calloc (swap_num, PATH_MAX);
553 ERROR ("swap plugin: malloc failed.");
557 for (i = 0; i < swap_num; i++)
558 s->swt_ent[i].ste_path = s_paths + (i * PATH_MAX);
561 status = swapctl (SC_LIST, s);
565 ERROR ("swap plugin: swapctl (SC_LIST) failed: %s",
566 sstrerror (errno, errbuf, sizeof (errbuf)));
571 else if (swap_num < status)
573 /* more elements returned than requested */
574 ERROR ("swap plugin: I allocated memory for %i structure%s, "
575 "but swapctl(2) claims to have returned %i. "
576 "I'm confused and will give up.",
577 swap_num, (swap_num == 1) ? "" : "s",
583 else if (swap_num > status)
584 /* less elements returned than requested */
587 for (i = 0; i < swap_num; i++)
593 if ((s->swt_ent[i].ste_flags & ST_INDEL) != 0)
596 this_total = (gauge_t) (s->swt_ent[i].ste_pages * pagesize);
597 this_avail = (gauge_t) (s->swt_ent[i].ste_free * pagesize);
599 /* Shortcut for the "combined" setting (default) */
600 if (!report_by_device)
607 sstrncpy (path, s->swt_ent[i].ste_path, sizeof (path));
608 escape_slashes (path, sizeof (path));
610 swap_submit_usage (path, this_total - this_avail, this_avail,
612 } /* for (swap_num) */
616 ERROR ("swap plugin: Total swap space (%g) is less than free swap space (%g).",
623 /* If the "separate" option was specified (report_by_device == 1), all
624 * values have already been dispatched from within the loop. */
625 if (!report_by_device)
626 swap_submit_usage (NULL, total - avail, avail, NULL, NAN);
631 } /* }}} int swap_read */
632 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
634 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
635 static int swap_read (void) /* {{{ */
637 struct swapent *swap_entries;
645 swap_num = swapctl (SWAP_NSWAP, NULL, 0);
648 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
652 else if (swap_num == 0)
655 swap_entries = calloc (swap_num, sizeof (*swap_entries));
656 if (swap_entries == NULL)
658 ERROR ("swap plugin: calloc failed.");
662 status = swapctl (SWAP_STATS, swap_entries, swap_num);
663 if (status != swap_num)
665 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
667 sfree (swap_entries);
671 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
672 # define C_SWAP_BLOCK_SIZE ((gauge_t) DEV_BSIZE)
674 # define C_SWAP_BLOCK_SIZE 512.0
677 /* TODO: Report per-device stats. The path name is available from
678 * swap_entries[i].se_path */
679 for (i = 0; i < swap_num; i++)
681 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
684 used += ((gauge_t) swap_entries[i].se_inuse) * C_SWAP_BLOCK_SIZE;
685 total += ((gauge_t) swap_entries[i].se_nblks) * C_SWAP_BLOCK_SIZE;
690 ERROR ("swap plugin: Total swap space (%g) is less than used swap space (%g).",
695 swap_submit_usage (NULL, used, total - used, NULL, NAN);
697 sfree (swap_entries);
699 } /* }}} int swap_read */
700 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
702 #elif defined(VM_SWAPUSAGE)
703 static int swap_read (void) /* {{{ */
707 struct xsw_usage sw_usage;
712 mib[1] = VM_SWAPUSAGE;
714 sw_usage_len = sizeof (struct xsw_usage);
716 if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
719 /* The returned values are bytes. */
720 swap_submit_usage (NULL,
721 (gauge_t) sw_usage.xsu_used, (gauge_t) sw_usage.xsu_avail,
725 } /* }}} int swap_read */
726 /* #endif VM_SWAPUSAGE */
728 #elif HAVE_LIBKVM_GETSWAPINFO
729 static int swap_read (void) /* {{{ */
731 struct kvm_swap data_s;
740 /* only one structure => only get the grand total, no details */
741 status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
745 total = (gauge_t) data_s.ksw_total;
746 used = (gauge_t) data_s.ksw_used;
748 total *= (gauge_t) kvm_pagesize;
749 used *= (gauge_t) kvm_pagesize;
751 swap_submit_usage (NULL, used, total - used, NULL, NAN);
754 } /* }}} int swap_read */
755 /* #endif HAVE_LIBKVM_GETSWAPINFO */
757 #elif HAVE_LIBSTATGRAB
758 static int swap_read (void) /* {{{ */
762 swap = sg_get_swap_stats ();
766 swap_submit_usage (NULL, (gauge_t) swap->used, (gauge_t) swap->free,
770 } /* }}} int swap_read */
771 /* #endif HAVE_LIBSTATGRAB */
774 static int swap_read (void) /* {{{ */
776 perfstat_memory_total_t pmemory;
783 memset (&pmemory, 0, sizeof (pmemory));
784 status = perfstat_memory_total (NULL, &pmemory, sizeof(perfstat_memory_total_t), 1);
788 WARNING ("swap plugin: perfstat_memory_total failed: %s",
789 sstrerror (errno, errbuf, sizeof (errbuf)));
793 total = (gauge_t) (pmemory.pgsp_total * pagesize);
794 free = (gauge_t) (pmemory.pgsp_free * pagesize);
795 reserved = (gauge_t) (pmemory.pgsp_rsvd * pagesize);
797 swap_submit_usage (NULL, total - free, free, "reserved", reserved);
798 swap_submit_derive (NULL, "in", (derive_t) pmemory.pgspins * pagesize);
799 swap_submit_derive (NULL, "out", (derive_t) pmemory.pgspouts * pagesize);
802 } /* }}} int swap_read */
803 #endif /* HAVE_PERFSTAT */
805 void module_register (void)
807 plugin_register_complex_config ("swap", swap_config);
808 plugin_register_init ("swap", swap_init);
809 plugin_register_read ("swap", swap_read);
810 } /* void module_register */
812 /* vim: set fdm=marker : */