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 HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
86 /* No global variables */
87 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
89 #elif defined(VM_SWAPUSAGE)
90 /* No global variables */
91 /* #endif defined(VM_SWAPUSAGE) */
93 #elif HAVE_LIBKVM_GETSWAPINFO
94 static kvm_t *kvm_obj = NULL;
96 /* #endif HAVE_LIBKVM_GETSWAPINFO */
98 #elif HAVE_LIBSTATGRAB
99 /* No global variables */
100 /* #endif HAVE_LIBSTATGRAB */
104 /*# endif HAVE_PERFSTAT */
107 # error "No applicable input method."
108 #endif /* HAVE_LIBSTATGRAB */
110 static _Bool values_absolute = 1;
111 static _Bool values_percentage = 0;
113 static int swap_config (oconfig_item_t *ci) /* {{{ */
117 for (i = 0; i < ci->children_num; i++)
119 oconfig_item_t *child = ci->children + i;
120 if (strcasecmp ("ReportBytes", child->key) == 0)
122 cf_util_get_boolean (child, &report_bytes);
124 WARNING ("swap plugin: The \"ReportBytes\" option "
125 "is only valid under Linux. "
126 "The option is going to be ignored.");
128 else if (strcasecmp ("ReportByDevice", child->key) == 0)
129 #if SWAP_HAVE_REPORT_BY_DEVICE
130 cf_util_get_boolean (child, &report_by_device);
132 WARNING ("swap plugin: The \"ReportByDevice\" option "
133 "is not supported on this platform. "
134 "The option is going to be ignored.");
135 #endif /* SWAP_HAVE_REPORT_BY_DEVICE */
136 else if (strcasecmp ("ValuesAbsolute", child->key) == 0)
137 cf_util_get_boolean (child, &values_absolute);
138 else if (strcasecmp ("ValuesPercentage", child->key) == 0)
139 cf_util_get_boolean (child, &values_percentage);
141 WARNING ("swap plugin: Unknown config option: \"%s\"",
146 } /* }}} int swap_config */
148 static int swap_init (void) /* {{{ */
151 pagesize = (derive_t) sysconf (_SC_PAGESIZE);
152 /* #endif KERNEL_LINUX */
154 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
155 /* getpagesize(3C) tells me this does not fail.. */
156 pagesize = (derive_t) getpagesize ();
157 /* #endif HAVE_SWAPCTL */
159 #elif defined(VM_SWAPUSAGE)
161 /* #endif defined(VM_SWAPUSAGE) */
163 #elif HAVE_LIBKVM_GETSWAPINFO
164 char errbuf[_POSIX2_LINE_MAX];
172 kvm_pagesize = getpagesize ();
174 kvm_obj = kvm_openfiles (NULL, "/dev/null", NULL, O_RDONLY, errbuf);
178 ERROR ("swap plugin: kvm_openfiles failed, %s", errbuf);
181 /* #endif HAVE_LIBKVM_GETSWAPINFO */
183 #elif HAVE_LIBSTATGRAB
185 /* #endif HAVE_LIBSTATGRAB */
188 pagesize = getpagesize();
189 #endif /* HAVE_PERFSTAT */
192 } /* }}} int swap_init */
194 static void swap_submit_usage (char const *plugin_instance, /* {{{ */
195 gauge_t used, gauge_t free,
196 char const *other_name, gauge_t other_value)
199 value_list_t vl = VALUE_LIST_INIT;
202 vl.values_len = STATIC_ARRAY_SIZE (v);
203 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
204 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
205 if (plugin_instance != NULL)
206 sstrncpy (vl.plugin_instance, plugin_instance,
207 sizeof (vl.plugin_instance));
208 sstrncpy (vl.type, "swap", sizeof (vl.type));
211 plugin_dispatch_multivalue (&vl, 0, DS_TYPE_GAUGE,
212 "used", used, "free", free,
213 other_name, other_value, NULL);
214 if (values_percentage)
215 plugin_dispatch_multivalue (&vl, 1, DS_TYPE_GAUGE,
216 "used", used, "free", free,
217 other_name, other_value, NULL);
218 } /* }}} void swap_submit_usage */
220 #if KERNEL_LINUX || HAVE_PERFSTAT
221 __attribute__((nonnull(1)))
222 static void swap_submit_derive (char const *type_instance, /* {{{ */
225 value_list_t vl = VALUE_LIST_INIT;
231 vl.values_len = STATIC_ARRAY_SIZE (v);
232 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
233 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
234 sstrncpy (vl.type, "swap_io", sizeof (vl.type));
235 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
237 plugin_dispatch_values (&vl);
238 } /* }}} void swap_submit_derive */
242 static int swap_read_separate (void) /* {{{ */
247 fh = fopen ("/proc/swaps", "r");
251 WARNING ("swap plugin: fopen (/proc/swaps) failed: %s",
252 sstrerror (errno, errbuf, sizeof (errbuf)));
256 while (fgets (buffer, sizeof (buffer), fh) != NULL)
266 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
270 sstrncpy (path, fields[0], sizeof (path));
271 escape_slashes (path, sizeof (path));
275 total = strtod (fields[2], &endptr);
276 if ((endptr == fields[2]) || (errno != 0))
281 used = strtod (fields[3], &endptr);
282 if ((endptr == fields[3]) || (errno != 0))
288 swap_submit_usage (path, used * 1024.0, (total - used) * 1024.0,
295 } /* }}} int swap_read_separate */
297 static int swap_read_combined (void) /* {{{ */
302 gauge_t swap_used = NAN;
303 gauge_t swap_cached = NAN;
304 gauge_t swap_free = NAN;
305 gauge_t swap_total = NAN;
307 fh = fopen ("/proc/meminfo", "r");
311 WARNING ("swap plugin: fopen (/proc/meminfo) failed: %s",
312 sstrerror (errno, errbuf, sizeof (errbuf)));
316 while (fgets (buffer, sizeof (buffer), fh) != NULL)
321 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
325 if (strcasecmp (fields[0], "SwapTotal:") == 0)
326 strtogauge (fields[1], &swap_total);
327 else if (strcasecmp (fields[0], "SwapFree:") == 0)
328 strtogauge (fields[1], &swap_free);
329 else if (strcasecmp (fields[0], "SwapCached:") == 0)
330 strtogauge (fields[1], &swap_cached);
335 if (isnan (swap_total) || isnan (swap_free))
338 /* Some systems, OpenVZ for example, don't provide SwapCached. */
339 if (isnan (swap_cached))
340 swap_used = swap_total - swap_free;
342 swap_used = swap_total - (swap_free + swap_cached);
343 assert (!isnan (swap_used));
348 swap_submit_usage (NULL, swap_used * 1024.0, swap_free * 1024.0,
349 isnan (swap_cached) ? NULL : "cached",
350 isnan (swap_cached) ? NAN : swap_cached * 1024.0);
352 } /* }}} int swap_read_combined */
354 static int swap_read_io (void) /* {{{ */
359 _Bool old_kernel = 0;
361 uint8_t have_data = 0;
362 derive_t swap_in = 0;
363 derive_t swap_out = 0;
365 fh = fopen ("/proc/vmstat", "r");
368 /* /proc/vmstat does not exist in kernels <2.6 */
369 fh = fopen ("/proc/stat", "r");
373 WARNING ("swap: fopen: %s",
374 sstrerror (errno, errbuf, sizeof (errbuf)));
381 while (fgets (buffer, sizeof (buffer), fh) != NULL)
386 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
393 if (strcasecmp ("pswpin", fields[0]) == 0)
395 strtoderive (fields[1], &swap_in);
398 else if (strcasecmp ("pswpout", fields[0]) == 0)
400 strtoderive (fields[1], &swap_out);
404 else /* if (old_kernel) */
409 if (strcasecmp ("page", fields[0]) == 0)
411 strtoderive (fields[1], &swap_in);
412 strtoderive (fields[2], &swap_out);
415 } /* while (fgets) */
419 if (have_data != 0x03)
424 swap_in = swap_in * pagesize;
425 swap_out = swap_out * pagesize;
428 swap_submit_derive ("in", swap_in);
429 swap_submit_derive ("out", swap_out);
432 } /* }}} int swap_read_io */
434 static int swap_read (void) /* {{{ */
436 if (report_by_device)
437 swap_read_separate ();
439 swap_read_combined ();
444 } /* }}} int swap_read */
445 /* #endif KERNEL_LINUX */
448 * Under Solaris, two mechanisms can be used to read swap statistics, swapctl
449 * and kstat. The former reads physical space used on a device, the latter
450 * reports the view from the virtual memory system. It was decided that the
451 * kstat-based information should be moved to the "vmem" plugin, but nobody
452 * with enough Solaris experience was available at that time to do this. The
453 * code below is still there for your reference but it won't be activated in
454 * *this* plugin again. --octo
456 #elif 0 && HAVE_LIBKSTAT
457 /* kstat-based read function */
458 static int swap_read_kstat (void) /* {{{ */
466 if (swapctl (SC_AINFO, &ai) == -1)
469 ERROR ("swap plugin: swapctl failed: %s",
470 sstrerror (errno, errbuf, sizeof (errbuf)));
476 * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
478 * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
479 * /usr/include/vm/anon.h
481 * In short, swap -s shows: allocated + reserved = used, available
483 * However, Solaris does not allow to allocated/reserved more than the
484 * available swap (physical memory + disk swap), so the pedant may
485 * prefer: allocated + unallocated = reserved, available
487 * We map the above to: used + resv = n/a, free
489 * Does your brain hurt yet? - Christophe Kalt
491 * Oh, and in case you wonder,
492 * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
493 * can suffer from a 32bit overflow.
495 swap_alloc = (gauge_t) ((ai.ani_max - ai.ani_free) * pagesize);
496 swap_resv = (gauge_t) ((ai.ani_resv + ai.ani_free - ai.ani_max) * pagesize);
497 swap_avail = (gauge_t) ((ai.ani_max - ai.ani_resv) * pagesize);
499 swap_submit_usage (NULL, swap_alloc, swap_avail, "reserved", swap_resv);
501 } /* }}} int swap_read_kstat */
502 /* #endif 0 && HAVE_LIBKSTAT */
504 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
505 /* swapctl-based read function */
506 static int swap_read (void) /* {{{ */
517 swap_num = swapctl (SC_GETNSWP, NULL);
520 ERROR ("swap plugin: swapctl (SC_GETNSWP) failed with status %i.",
524 else if (swap_num == 0)
527 /* Allocate and initialize the swaptbl_t structure */
528 s = malloc (swap_num * sizeof (swapent_t) + sizeof (struct swaptable));
531 ERROR ("swap plugin: malloc failed.");
535 /* Memory to store the path names. We only use these paths when the
536 * separate option has been configured, but it's easier to just
537 * allocate enough memory in any case. */
538 s_paths = calloc (swap_num, PATH_MAX);
541 ERROR ("swap plugin: calloc failed.");
545 for (i = 0; i < swap_num; i++)
546 s->swt_ent[i].ste_path = s_paths + (i * PATH_MAX);
549 status = swapctl (SC_LIST, s);
553 ERROR ("swap plugin: swapctl (SC_LIST) failed: %s",
554 sstrerror (errno, errbuf, sizeof (errbuf)));
559 else if (swap_num < status)
561 /* more elements returned than requested */
562 ERROR ("swap plugin: I allocated memory for %i structure%s, "
563 "but swapctl(2) claims to have returned %i. "
564 "I'm confused and will give up.",
565 swap_num, (swap_num == 1) ? "" : "s",
571 else if (swap_num > status)
572 /* less elements returned than requested */
575 for (i = 0; i < swap_num; i++)
581 if ((s->swt_ent[i].ste_flags & ST_INDEL) != 0)
584 this_total = (gauge_t) (s->swt_ent[i].ste_pages * pagesize);
585 this_avail = (gauge_t) (s->swt_ent[i].ste_free * pagesize);
587 /* Shortcut for the "combined" setting (default) */
588 if (!report_by_device)
595 sstrncpy (path, s->swt_ent[i].ste_path, sizeof (path));
596 escape_slashes (path, sizeof (path));
598 swap_submit_usage (path, this_total - this_avail, this_avail,
600 } /* for (swap_num) */
604 ERROR ("swap plugin: Total swap space (%g) is less than free swap space (%g).",
611 /* If the "separate" option was specified (report_by_device == 1), all
612 * values have already been dispatched from within the loop. */
613 if (!report_by_device)
614 swap_submit_usage (NULL, total - avail, avail, NULL, NAN);
619 } /* }}} int swap_read */
620 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
622 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
623 static int swap_read (void) /* {{{ */
625 struct swapent *swap_entries;
633 swap_num = swapctl (SWAP_NSWAP, NULL, 0);
636 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
640 else if (swap_num == 0)
643 swap_entries = calloc (swap_num, sizeof (*swap_entries));
644 if (swap_entries == NULL)
646 ERROR ("swap plugin: calloc failed.");
650 status = swapctl (SWAP_STATS, swap_entries, swap_num);
651 if (status != swap_num)
653 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
655 sfree (swap_entries);
659 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
660 # define C_SWAP_BLOCK_SIZE ((gauge_t) DEV_BSIZE)
662 # define C_SWAP_BLOCK_SIZE 512.0
665 /* TODO: Report per-device stats. The path name is available from
666 * swap_entries[i].se_path */
667 for (i = 0; i < swap_num; i++)
669 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
672 used += ((gauge_t) swap_entries[i].se_inuse) * C_SWAP_BLOCK_SIZE;
673 total += ((gauge_t) swap_entries[i].se_nblks) * C_SWAP_BLOCK_SIZE;
678 ERROR ("swap plugin: Total swap space (%g) is less than used swap space (%g).",
683 swap_submit_usage (NULL, used, total - used, NULL, NAN);
685 sfree (swap_entries);
687 } /* }}} int swap_read */
688 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
690 #elif defined(VM_SWAPUSAGE)
691 static int swap_read (void) /* {{{ */
695 struct xsw_usage sw_usage;
700 mib[1] = VM_SWAPUSAGE;
702 sw_usage_len = sizeof (struct xsw_usage);
704 if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
707 /* The returned values are bytes. */
708 swap_submit_usage (NULL,
709 (gauge_t) sw_usage.xsu_used, (gauge_t) sw_usage.xsu_avail,
713 } /* }}} int swap_read */
714 /* #endif VM_SWAPUSAGE */
716 #elif HAVE_LIBKVM_GETSWAPINFO
717 static int swap_read (void) /* {{{ */
719 struct kvm_swap data_s;
728 /* only one structure => only get the grand total, no details */
729 status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
733 total = (gauge_t) data_s.ksw_total;
734 used = (gauge_t) data_s.ksw_used;
736 total *= (gauge_t) kvm_pagesize;
737 used *= (gauge_t) kvm_pagesize;
739 swap_submit_usage (NULL, used, total - used, NULL, NAN);
742 } /* }}} int swap_read */
743 /* #endif HAVE_LIBKVM_GETSWAPINFO */
745 #elif HAVE_LIBSTATGRAB
746 static int swap_read (void) /* {{{ */
750 swap = sg_get_swap_stats ();
754 swap_submit_usage (NULL, (gauge_t) swap->used, (gauge_t) swap->free,
758 } /* }}} int swap_read */
759 /* #endif HAVE_LIBSTATGRAB */
762 static int swap_read (void) /* {{{ */
764 perfstat_memory_total_t pmemory;
771 memset (&pmemory, 0, sizeof (pmemory));
772 status = perfstat_memory_total (NULL, &pmemory, sizeof(perfstat_memory_total_t), 1);
776 WARNING ("swap plugin: perfstat_memory_total failed: %s",
777 sstrerror (errno, errbuf, sizeof (errbuf)));
781 total = (gauge_t) (pmemory.pgsp_total * pagesize);
782 free = (gauge_t) (pmemory.pgsp_free * pagesize);
783 reserved = (gauge_t) (pmemory.pgsp_rsvd * pagesize);
785 swap_submit_usage (NULL, total - free, free, "reserved", reserved);
786 swap_submit_derive ("in", (derive_t) pmemory.pgspins * pagesize);
787 swap_submit_derive ("out", (derive_t) pmemory.pgspouts * pagesize);
790 } /* }}} int swap_read */
791 #endif /* HAVE_PERFSTAT */
793 void module_register (void)
795 plugin_register_complex_config ("swap", swap_config);
796 plugin_register_init ("swap", swap_init);
797 plugin_register_read ("swap", swap_read);
798 } /* void module_register */
800 /* vim: set fdm=marker : */