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
43 # include <sys/swap.h>
49 # include <sys/param.h>
52 # include <sys/sysctl.h>
55 # include <sys/dkstat.h>
62 # include <statgrab.h>
66 # include <sys/protosw.h>
67 # include <libperfstat.h>
71 #define MAX(x,y) ((x) > (y) ? (x) : (y))
74 # define SWAP_HAVE_REPORT_BY_DEVICE 1
75 static derive_t pagesize;
76 static _Bool report_bytes = 0;
77 static _Bool report_by_device = 0;
78 /* #endif KERNEL_LINUX */
80 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
81 # define SWAP_HAVE_REPORT_BY_DEVICE 1
82 static derive_t pagesize;
83 static _Bool report_by_device = 0;
84 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
86 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
87 /* No global variables */
88 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
90 #elif defined(VM_SWAPUSAGE)
91 /* No global variables */
92 /* #endif defined(VM_SWAPUSAGE) */
94 #elif HAVE_LIBKVM_GETSWAPINFO
95 static kvm_t *kvm_obj = NULL;
97 /* #endif HAVE_LIBKVM_GETSWAPINFO */
99 #elif HAVE_LIBSTATGRAB
100 /* No global variables */
101 /* #endif HAVE_LIBSTATGRAB */
105 /*# endif HAVE_PERFSTAT */
108 # error "No applicable input method."
109 #endif /* HAVE_LIBSTATGRAB */
111 static _Bool values_absolute = 1;
112 static _Bool values_percentage = 0;
114 static int swap_config (oconfig_item_t *ci) /* {{{ */
116 for (int i = 0; i < ci->children_num; i++)
118 oconfig_item_t *child = ci->children + i;
119 if (strcasecmp ("ReportBytes", child->key) == 0)
121 cf_util_get_boolean (child, &report_bytes);
123 WARNING ("swap plugin: The \"ReportBytes\" option "
124 "is only valid under Linux. "
125 "The option is going to be ignored.");
127 else if (strcasecmp ("ReportByDevice", child->key) == 0)
128 #if SWAP_HAVE_REPORT_BY_DEVICE
129 cf_util_get_boolean (child, &report_by_device);
131 WARNING ("swap plugin: The \"ReportByDevice\" option "
132 "is not supported on this platform. "
133 "The option is going to be ignored.");
134 #endif /* SWAP_HAVE_REPORT_BY_DEVICE */
135 else if (strcasecmp ("ValuesAbsolute", child->key) == 0)
136 cf_util_get_boolean (child, &values_absolute);
137 else if (strcasecmp ("ValuesPercentage", child->key) == 0)
138 cf_util_get_boolean (child, &values_percentage);
140 WARNING ("swap plugin: Unknown config option: \"%s\"",
145 } /* }}} int swap_config */
147 static int swap_init (void) /* {{{ */
150 pagesize = (derive_t) sysconf (_SC_PAGESIZE);
151 /* #endif KERNEL_LINUX */
153 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
154 /* getpagesize(3C) tells me this does not fail.. */
155 pagesize = (derive_t) getpagesize ();
156 /* #endif HAVE_SWAPCTL */
158 #elif defined(VM_SWAPUSAGE)
160 /* #endif defined(VM_SWAPUSAGE) */
162 #elif HAVE_LIBKVM_GETSWAPINFO
163 char errbuf[_POSIX2_LINE_MAX];
171 kvm_pagesize = getpagesize ();
173 kvm_obj = kvm_openfiles (NULL, "/dev/null", NULL, O_RDONLY, errbuf);
177 ERROR ("swap plugin: kvm_openfiles failed, %s", errbuf);
180 /* #endif HAVE_LIBKVM_GETSWAPINFO */
182 #elif HAVE_LIBSTATGRAB
184 /* #endif HAVE_LIBSTATGRAB */
187 pagesize = getpagesize();
188 #endif /* HAVE_PERFSTAT */
191 } /* }}} int swap_init */
193 static void swap_submit_usage (char const *plugin_instance, /* {{{ */
194 gauge_t used, gauge_t free,
195 char const *other_name, gauge_t other_value)
198 value_list_t vl = VALUE_LIST_INIT;
201 vl.values_len = STATIC_ARRAY_SIZE (v);
202 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
203 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
204 if (plugin_instance != NULL)
205 sstrncpy (vl.plugin_instance, plugin_instance,
206 sizeof (vl.plugin_instance));
207 sstrncpy (vl.type, "swap", sizeof (vl.type));
210 plugin_dispatch_multivalue (&vl, 0, DS_TYPE_GAUGE,
211 "used", used, "free", free,
212 other_name, other_value, NULL);
213 if (values_percentage)
214 plugin_dispatch_multivalue (&vl, 1, DS_TYPE_GAUGE,
215 "used", used, "free", free,
216 other_name, other_value, NULL);
217 } /* }}} void swap_submit_usage */
219 #if KERNEL_LINUX || HAVE_PERFSTAT
220 __attribute__((nonnull(1)))
221 static void swap_submit_derive (char const *type_instance, /* {{{ */
224 value_list_t vl = VALUE_LIST_INIT;
230 vl.values_len = STATIC_ARRAY_SIZE (v);
231 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
232 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
233 sstrncpy (vl.type, "swap_io", sizeof (vl.type));
234 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
236 plugin_dispatch_values (&vl);
237 } /* }}} void swap_submit_derive */
241 static int swap_read_separate (void) /* {{{ */
246 fh = fopen ("/proc/swaps", "r");
250 WARNING ("swap plugin: fopen (/proc/swaps) failed: %s",
251 sstrerror (errno, errbuf, sizeof (errbuf)));
255 while (fgets (buffer, sizeof (buffer), fh) != NULL)
265 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
269 sstrncpy (path, fields[0], sizeof (path));
270 escape_slashes (path, sizeof (path));
274 total = strtod (fields[2], &endptr);
275 if ((endptr == fields[2]) || (errno != 0))
280 used = strtod (fields[3], &endptr);
281 if ((endptr == fields[3]) || (errno != 0))
287 swap_submit_usage (path, used * 1024.0, (total - used) * 1024.0,
294 } /* }}} int swap_read_separate */
296 static int swap_read_combined (void) /* {{{ */
301 gauge_t swap_used = NAN;
302 gauge_t swap_cached = NAN;
303 gauge_t swap_free = NAN;
304 gauge_t swap_total = NAN;
306 fh = fopen ("/proc/meminfo", "r");
310 WARNING ("swap plugin: fopen (/proc/meminfo) failed: %s",
311 sstrerror (errno, errbuf, sizeof (errbuf)));
315 while (fgets (buffer, sizeof (buffer), fh) != NULL)
320 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
324 if (strcasecmp (fields[0], "SwapTotal:") == 0)
325 strtogauge (fields[1], &swap_total);
326 else if (strcasecmp (fields[0], "SwapFree:") == 0)
327 strtogauge (fields[1], &swap_free);
328 else if (strcasecmp (fields[0], "SwapCached:") == 0)
329 strtogauge (fields[1], &swap_cached);
334 if (isnan (swap_total) || isnan (swap_free))
337 /* Some systems, OpenVZ for example, don't provide SwapCached. */
338 if (isnan (swap_cached))
339 swap_used = swap_total - swap_free;
341 swap_used = swap_total - (swap_free + swap_cached);
342 assert (!isnan (swap_used));
347 swap_submit_usage (NULL, swap_used * 1024.0, swap_free * 1024.0,
348 isnan (swap_cached) ? NULL : "cached",
349 isnan (swap_cached) ? NAN : swap_cached * 1024.0);
351 } /* }}} int swap_read_combined */
353 static int swap_read_io (void) /* {{{ */
358 _Bool old_kernel = 0;
360 uint8_t have_data = 0;
361 derive_t swap_in = 0;
362 derive_t swap_out = 0;
364 fh = fopen ("/proc/vmstat", "r");
367 /* /proc/vmstat does not exist in kernels <2.6 */
368 fh = fopen ("/proc/stat", "r");
372 WARNING ("swap: fopen: %s",
373 sstrerror (errno, errbuf, sizeof (errbuf)));
380 while (fgets (buffer, sizeof (buffer), fh) != NULL)
385 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
392 if (strcasecmp ("pswpin", fields[0]) == 0)
394 strtoderive (fields[1], &swap_in);
397 else if (strcasecmp ("pswpout", fields[0]) == 0)
399 strtoderive (fields[1], &swap_out);
403 else /* if (old_kernel) */
408 if (strcasecmp ("page", fields[0]) == 0)
410 strtoderive (fields[1], &swap_in);
411 strtoderive (fields[2], &swap_out);
414 } /* while (fgets) */
418 if (have_data != 0x03)
423 swap_in = swap_in * pagesize;
424 swap_out = swap_out * pagesize;
427 swap_submit_derive ("in", swap_in);
428 swap_submit_derive ("out", swap_out);
431 } /* }}} int swap_read_io */
433 static int swap_read (void) /* {{{ */
435 if (report_by_device)
436 swap_read_separate ();
438 swap_read_combined ();
443 } /* }}} int swap_read */
444 /* #endif KERNEL_LINUX */
447 * Under Solaris, two mechanisms can be used to read swap statistics, swapctl
448 * and kstat. The former reads physical space used on a device, the latter
449 * reports the view from the virtual memory system. It was decided that the
450 * kstat-based information should be moved to the "vmem" plugin, but nobody
451 * with enough Solaris experience was available at that time to do this. The
452 * code below is still there for your reference but it won't be activated in
453 * *this* plugin again. --octo
455 #elif 0 && HAVE_LIBKSTAT
456 /* kstat-based read function */
457 static int swap_read_kstat (void) /* {{{ */
465 if (swapctl (SC_AINFO, &ai) == -1)
468 ERROR ("swap plugin: swapctl failed: %s",
469 sstrerror (errno, errbuf, sizeof (errbuf)));
475 * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
477 * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
478 * /usr/include/vm/anon.h
480 * In short, swap -s shows: allocated + reserved = used, available
482 * However, Solaris does not allow to allocated/reserved more than the
483 * available swap (physical memory + disk swap), so the pedant may
484 * prefer: allocated + unallocated = reserved, available
486 * We map the above to: used + resv = n/a, free
488 * Does your brain hurt yet? - Christophe Kalt
490 * Oh, and in case you wonder,
491 * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
492 * can suffer from a 32bit overflow.
494 swap_alloc = (gauge_t) ((ai.ani_max - ai.ani_free) * pagesize);
495 swap_resv = (gauge_t) ((ai.ani_resv + ai.ani_free - ai.ani_max) * pagesize);
496 swap_avail = (gauge_t) ((ai.ani_max - ai.ani_resv) * pagesize);
498 swap_submit_usage (NULL, swap_alloc, swap_avail, "reserved", swap_resv);
500 } /* }}} int swap_read_kstat */
501 /* #endif 0 && HAVE_LIBKSTAT */
503 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
504 /* swapctl-based read function */
505 static int swap_read (void) /* {{{ */
515 swap_num = swapctl (SC_GETNSWP, NULL);
518 ERROR ("swap plugin: swapctl (SC_GETNSWP) failed with status %i.",
522 else if (swap_num == 0)
525 /* Allocate and initialize the swaptbl_t structure */
526 s = malloc (swap_num * sizeof (swapent_t) + sizeof (struct swaptable));
529 ERROR ("swap plugin: malloc failed.");
533 /* Memory to store the path names. We only use these paths when the
534 * separate option has been configured, but it's easier to just
535 * allocate enough memory in any case. */
536 s_paths = calloc (swap_num, PATH_MAX);
539 ERROR ("swap plugin: calloc failed.");
543 for (int i = 0; i < swap_num; i++)
544 s->swt_ent[i].ste_path = s_paths + (i * PATH_MAX);
547 status = swapctl (SC_LIST, s);
551 ERROR ("swap plugin: swapctl (SC_LIST) failed: %s",
552 sstrerror (errno, errbuf, sizeof (errbuf)));
557 else if (swap_num < status)
559 /* more elements returned than requested */
560 ERROR ("swap plugin: I allocated memory for %i structure%s, "
561 "but swapctl(2) claims to have returned %i. "
562 "I'm confused and will give up.",
563 swap_num, (swap_num == 1) ? "" : "s",
569 else if (swap_num > status)
570 /* less elements returned than requested */
573 for (int i = 0; i < swap_num; i++)
579 if ((s->swt_ent[i].ste_flags & ST_INDEL) != 0)
582 this_total = (gauge_t) (s->swt_ent[i].ste_pages * pagesize);
583 this_avail = (gauge_t) (s->swt_ent[i].ste_free * pagesize);
585 /* Shortcut for the "combined" setting (default) */
586 if (!report_by_device)
593 sstrncpy (path, s->swt_ent[i].ste_path, sizeof (path));
594 escape_slashes (path, sizeof (path));
596 swap_submit_usage (path, this_total - this_avail, this_avail,
598 } /* for (swap_num) */
602 ERROR ("swap plugin: Total swap space (%g) is less than free swap space (%g).",
609 /* If the "separate" option was specified (report_by_device == 1), all
610 * values have already been dispatched from within the loop. */
611 if (!report_by_device)
612 swap_submit_usage (NULL, total - avail, avail, NULL, NAN);
617 } /* }}} int swap_read */
618 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
620 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
621 static int swap_read (void) /* {{{ */
623 struct swapent *swap_entries;
630 swap_num = swapctl (SWAP_NSWAP, NULL, 0);
633 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
637 else if (swap_num == 0)
640 swap_entries = calloc (swap_num, sizeof (*swap_entries));
641 if (swap_entries == NULL)
643 ERROR ("swap plugin: calloc failed.");
647 status = swapctl (SWAP_STATS, swap_entries, swap_num);
648 if (status != swap_num)
650 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
652 sfree (swap_entries);
656 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
657 # define C_SWAP_BLOCK_SIZE ((gauge_t) DEV_BSIZE)
659 # define C_SWAP_BLOCK_SIZE 512.0
662 /* TODO: Report per-device stats. The path name is available from
663 * swap_entries[i].se_path */
664 for (int i = 0; i < swap_num; i++)
666 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
669 used += ((gauge_t) swap_entries[i].se_inuse) * C_SWAP_BLOCK_SIZE;
670 total += ((gauge_t) swap_entries[i].se_nblks) * C_SWAP_BLOCK_SIZE;
675 ERROR ("swap plugin: Total swap space (%g) is less than used swap space (%g).",
677 sfree (swap_entries);
681 swap_submit_usage (NULL, used, total - used, NULL, NAN);
683 sfree (swap_entries);
685 } /* }}} int swap_read */
686 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
688 #elif defined(VM_SWAPUSAGE)
689 static int swap_read (void) /* {{{ */
693 struct xsw_usage sw_usage;
698 mib[1] = VM_SWAPUSAGE;
700 sw_usage_len = sizeof (struct xsw_usage);
702 if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
705 /* The returned values are bytes. */
706 swap_submit_usage (NULL,
707 (gauge_t) sw_usage.xsu_used, (gauge_t) sw_usage.xsu_avail,
711 } /* }}} int swap_read */
712 /* #endif VM_SWAPUSAGE */
714 #elif HAVE_LIBKVM_GETSWAPINFO
715 static int swap_read (void) /* {{{ */
717 struct kvm_swap data_s;
726 /* only one structure => only get the grand total, no details */
727 status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
731 total = (gauge_t) data_s.ksw_total;
732 used = (gauge_t) data_s.ksw_used;
734 total *= (gauge_t) kvm_pagesize;
735 used *= (gauge_t) kvm_pagesize;
737 swap_submit_usage (NULL, used, total - used, NULL, NAN);
740 } /* }}} int swap_read */
741 /* #endif HAVE_LIBKVM_GETSWAPINFO */
743 #elif HAVE_LIBSTATGRAB
744 static int swap_read (void) /* {{{ */
748 swap = sg_get_swap_stats ();
752 swap_submit_usage (NULL, (gauge_t) swap->used, (gauge_t) swap->free,
756 } /* }}} int swap_read */
757 /* #endif HAVE_LIBSTATGRAB */
760 static int swap_read (void) /* {{{ */
762 perfstat_memory_total_t pmemory = { 0 };
769 status = perfstat_memory_total (NULL, &pmemory, sizeof(perfstat_memory_total_t), 1);
773 WARNING ("swap plugin: perfstat_memory_total failed: %s",
774 sstrerror (errno, errbuf, sizeof (errbuf)));
778 total = (gauge_t) (pmemory.pgsp_total * pagesize);
779 free = (gauge_t) (pmemory.pgsp_free * pagesize);
780 reserved = (gauge_t) (pmemory.pgsp_rsvd * pagesize);
782 swap_submit_usage (NULL, total - free, free, "reserved", reserved);
783 swap_submit_derive ("in", (derive_t) pmemory.pgspins * pagesize);
784 swap_submit_derive ("out", (derive_t) pmemory.pgspouts * pagesize);
787 } /* }}} int swap_read */
788 #endif /* HAVE_PERFSTAT */
790 void module_register (void)
792 plugin_register_complex_config ("swap", swap_config);
793 plugin_register_init ("swap", swap_init);
794 plugin_register_read ("swap", swap_read);
795 } /* void module_register */
797 /* vim: set fdm=marker : */