2 * collectd - src/swap.c
3 * Copyright (C) 2005-2012 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 static perfstat_memory_total_t pmemory;
101 /*# endif HAVE_PERFSTAT */
104 # error "No applicable input method."
105 #endif /* HAVE_LIBSTATGRAB */
107 static const char *config_keys[] =
112 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
114 static int swap_config (const char *key, const char *value) /* {{{ */
116 if (strcasecmp ("ReportBytes", key) == 0)
119 report_bytes = IS_TRUE (value) ? 1 : 0;
121 WARNING ("swap plugin: The \"ReportBytes\" option is only "
122 "valid under Linux. "
123 "The option is going to be ignored.");
126 else if (strcasecmp ("ReportByDevice", key) == 0)
128 #if SWAP_HAVE_REPORT_BY_DEVICE
130 report_by_device = 1;
132 report_by_device = 0;
134 WARNING ("swap plugin: The \"ReportByDevice\" option is not "
135 "supported on this platform. "
136 "The option is going to be ignored.");
137 #endif /* SWAP_HAVE_REPORT_BY_DEVICE */
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
169 kvm_pagesize = getpagesize ();
171 if ((kvm_obj = kvm_open (NULL, /* execfile */
174 O_RDONLY, /* flags */
178 ERROR ("swap plugin: kvm_open failed.");
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 (const char *plugin_instance, /* {{{ */
195 const char *type, const char *type_instance,
198 value_list_t vl = VALUE_LIST_INIT;
200 assert (type != NULL);
204 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
205 sstrncpy (vl.plugin, "swap", sizeof (vl.plugin));
206 if (plugin_instance != NULL)
207 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
208 sstrncpy (vl.type, type, sizeof (vl.type));
209 if (type_instance != NULL)
210 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
212 plugin_dispatch_values (&vl);
213 } /* }}} void swap_submit_inst */
215 static void swap_submit_gauge (const char *plugin_instance, /* {{{ */
216 const char *type_instance, gauge_t value)
221 swap_submit (plugin_instance, "swap", type_instance, v);
222 } /* }}} void swap_submit_gauge */
225 static void swap_submit_derive (const char *plugin_instance, /* {{{ */
226 const char *type_instance, derive_t value)
231 swap_submit (plugin_instance, "swap_io", type_instance, v);
232 } /* }}} void swap_submit_derive */
234 static int swap_read_separate (void) /* {{{ */
239 fh = fopen ("/proc/swaps", "r");
243 WARNING ("swap plugin: fopen (/proc/swaps) failed: %s",
244 sstrerror (errno, errbuf, sizeof (errbuf)));
248 while (fgets (buffer, sizeof (buffer), fh) != NULL)
259 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
263 sstrncpy (path, fields[0], sizeof (path));
264 escape_slashes (path, sizeof (path));
268 size = strtod (fields[2], &endptr);
269 if ((endptr == fields[2]) || (errno != 0))
274 used = strtod (fields[3], &endptr);
275 if ((endptr == fields[3]) || (errno != 0))
283 swap_submit_gauge (path, "used", used);
284 swap_submit_gauge (path, "free", free);
290 } /* }}} int swap_read_separate */
292 static int swap_read_combined (void) /* {{{ */
297 uint8_t have_data = 0;
298 gauge_t swap_used = 0.0;
299 gauge_t swap_cached = 0.0;
300 gauge_t swap_free = 0.0;
301 gauge_t swap_total = 0.0;
303 fh = fopen ("/proc/meminfo", "r");
307 WARNING ("swap plugin: fopen (/proc/meminfo) failed: %s",
308 sstrerror (errno, errbuf, sizeof (errbuf)));
312 while (fgets (buffer, sizeof (buffer), fh) != NULL)
317 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
321 if (strcasecmp (fields[0], "SwapTotal:") == 0)
323 swap_total = strtod (fields[1], /* endptr = */ NULL);
326 else if (strcasecmp (fields[0], "SwapFree:") == 0)
328 swap_free = strtod (fields[1], /* endptr = */ NULL);
331 else if (strcasecmp (fields[0], "SwapCached:") == 0)
333 swap_cached = strtod (fields[1], /* endptr = */ NULL);
340 if (have_data != 0x07)
343 if (isnan (swap_total)
344 || (swap_total <= 0.0)
345 || ((swap_free + swap_cached) > swap_total))
348 swap_used = swap_total - (swap_free + swap_cached);
350 swap_submit_gauge (NULL, "used", 1024.0 * swap_used);
351 swap_submit_gauge (NULL, "free", 1024.0 * swap_free);
352 swap_submit_gauge (NULL, "cached", 1024.0 * swap_cached);
355 } /* }}} int swap_read_combined */
357 static int swap_read_io (void) /* {{{ */
362 _Bool old_kernel = 0;
364 uint8_t have_data = 0;
365 derive_t swap_in = 0;
366 derive_t swap_out = 0;
368 fh = fopen ("/proc/vmstat", "r");
371 /* /proc/vmstat does not exist in kernels <2.6 */
372 fh = fopen ("/proc/stat", "r");
376 WARNING ("swap: fopen: %s",
377 sstrerror (errno, errbuf, sizeof (errbuf)));
384 while (fgets (buffer, sizeof (buffer), fh) != NULL)
389 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
396 if (strcasecmp ("pswpin", fields[0]) == 0)
398 strtoderive (fields[1], &swap_in);
401 else if (strcasecmp ("pswpout", fields[0]) == 0)
403 strtoderive (fields[1], &swap_out);
407 else /* if (old_kernel) */
412 if (strcasecmp ("page", fields[0]) == 0)
414 strtoderive (fields[1], &swap_in);
415 strtoderive (fields[2], &swap_out);
418 } /* while (fgets) */
422 if (have_data != 0x03)
427 swap_in = swap_in * pagesize;
428 swap_out = swap_out * pagesize;
431 swap_submit_derive (NULL, "in", swap_in);
432 swap_submit_derive (NULL, "out", swap_out);
435 } /* }}} int swap_read_io */
437 static int swap_read (void) /* {{{ */
439 if (report_by_device)
440 swap_read_separate ();
442 swap_read_combined ();
447 } /* }}} int swap_read */
448 /* #endif KERNEL_LINUX */
451 * Under Solaris, two mechanisms can be used to read swap statistics, swapctl
452 * and kstat. The former reads physical space used on a device, the latter
453 * reports the view from the virtual memory system. It was decided that the
454 * kstat-based information should be moved to the "vmem" plugin, but nobody
455 * with enough Solaris experience was available at that time to do this. The
456 * code below is still there for your reference but it won't be activated in
457 * *this* plugin again. --octo
459 #elif 0 && HAVE_LIBKSTAT
460 /* kstat-based read function */
461 static int swap_read_kstat (void) /* {{{ */
469 if (swapctl (SC_AINFO, &ai) == -1)
472 ERROR ("swap plugin: swapctl failed: %s",
473 sstrerror (errno, errbuf, sizeof (errbuf)));
479 * http://cvs.opensolaris.org/source/xref/on/usr/src/cmd/swap/swap.c
481 * http://www.itworld.com/Comp/2377/UIR980701perf/ (outdated?)
482 * /usr/include/vm/anon.h
484 * In short, swap -s shows: allocated + reserved = used, available
486 * However, Solaris does not allow to allocated/reserved more than the
487 * available swap (physical memory + disk swap), so the pedant may
488 * prefer: allocated + unallocated = reserved, available
490 * We map the above to: used + resv = n/a, free
492 * Does your brain hurt yet? - Christophe Kalt
494 * Oh, and in case you wonder,
495 * swap_alloc = pagesize * ( ai.ani_max - ai.ani_free );
496 * can suffer from a 32bit overflow.
498 swap_alloc = (derive_t) ((ai.ani_max - ai.ani_free) * pagesize);
499 swap_resv = (derive_t) ((ai.ani_resv + ai.ani_free - ai.ani_max)
501 swap_avail = (derive_t) ((ai.ani_max - ai.ani_resv) * pagesize);
503 swap_submit_gauge (NULL, "used", swap_alloc);
504 swap_submit_gauge (NULL, "free", swap_avail);
505 swap_submit_gauge (NULL, "reserved", swap_resv);
508 } /* }}} int swap_read_kstat */
509 /* #endif 0 && HAVE_LIBKSTAT */
511 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS
512 /* swapctl-based read function */
513 static int swap_read (void) /* {{{ */
524 swap_num = swapctl (SC_GETNSWP, NULL);
527 ERROR ("swap plugin: swapctl (SC_GETNSWP) failed with status %i.",
531 else if (swap_num == 0)
534 /* Allocate and initialize the swaptbl_t structure */
535 s = (swaptbl_t *) smalloc (swap_num * sizeof (swapent_t) + sizeof (struct swaptable));
538 ERROR ("swap plugin: smalloc failed.");
542 /* Memory to store the path names. We only use these paths when the
543 * separate option has been configured, but it's easier to just
544 * allocate enough memory in any case. */
545 s_paths = calloc (swap_num, PATH_MAX);
548 ERROR ("swap plugin: malloc failed.");
552 for (i = 0; i < swap_num; i++)
553 s->swt_ent[i].ste_path = s_paths + (i * PATH_MAX);
556 status = swapctl (SC_LIST, s);
560 ERROR ("swap plugin: swapctl (SC_LIST) failed: %s",
561 sstrerror (errno, errbuf, sizeof (errbuf)));
566 else if (swap_num < status)
568 /* more elements returned than requested */
569 ERROR ("swap plugin: I allocated memory for %i structure%s, "
570 "but swapctl(2) claims to have returned %i. "
571 "I'm confused and will give up.",
572 swap_num, (swap_num == 1) ? "" : "s",
578 else if (swap_num > status)
579 /* less elements returned than requested */
582 for (i = 0; i < swap_num; i++)
588 if ((s->swt_ent[i].ste_flags & ST_INDEL) != 0)
591 this_total = ((derive_t) s->swt_ent[i].ste_pages) * pagesize;
592 this_avail = ((derive_t) s->swt_ent[i].ste_free) * pagesize;
594 /* Shortcut for the "combined" setting (default) */
595 if (!report_by_device)
602 sstrncpy (path, s->swt_ent[i].ste_path, sizeof (path));
603 escape_slashes (path, sizeof (path));
605 swap_submit_gauge (path, "used", (gauge_t) (this_total - this_avail));
606 swap_submit_gauge (path, "free", (gauge_t) this_avail);
607 } /* for (swap_num) */
611 ERROR ("swap plugin: Total swap space (%"PRIi64") "
612 "is less than free swap space (%"PRIi64").",
619 /* If the "separate" option was specified (report_by_device == 2), all
620 * values have already been dispatched from within the loop. */
621 if (!report_by_device)
623 swap_submit_gauge (NULL, "used", (gauge_t) (total - avail));
624 swap_submit_gauge (NULL, "free", (gauge_t) avail);
630 } /* }}} int swap_read */
631 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_TWO_ARGS */
633 #elif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS
634 static int swap_read (void) /* {{{ */
636 struct swapent *swap_entries;
644 swap_num = swapctl (SWAP_NSWAP, NULL, 0);
647 ERROR ("swap plugin: swapctl (SWAP_NSWAP) failed with status %i.",
651 else if (swap_num == 0)
654 swap_entries = calloc (swap_num, sizeof (*swap_entries));
655 if (swap_entries == NULL)
657 ERROR ("swap plugin: calloc failed.");
661 status = swapctl (SWAP_STATS, swap_entries, swap_num);
662 if (status != swap_num)
664 ERROR ("swap plugin: swapctl (SWAP_STATS) failed with status %i.",
666 sfree (swap_entries);
670 #if defined(DEV_BSIZE) && (DEV_BSIZE > 0)
671 # define C_SWAP_BLOCK_SIZE ((derive_t) DEV_BSIZE)
673 # define C_SWAP_BLOCK_SIZE ((derive_t) 512)
676 for (i = 0; i < swap_num; i++)
678 if ((swap_entries[i].se_flags & SWF_ENABLE) == 0)
681 used += ((derive_t) swap_entries[i].se_inuse)
683 total += ((derive_t) swap_entries[i].se_nblks)
689 ERROR ("swap plugin: Total swap space (%"PRIu64") "
690 "is less than used swap space (%"PRIu64").",
695 swap_submit_gauge (NULL, "used", (gauge_t) used);
696 swap_submit_gauge (NULL, "free", (gauge_t) (total - used));
698 sfree (swap_entries);
701 } /* }}} int swap_read */
702 /* #endif HAVE_SWAPCTL && HAVE_SWAPCTL_THREE_ARGS */
704 #elif defined(VM_SWAPUSAGE)
705 static int swap_read (void) /* {{{ */
709 struct xsw_usage sw_usage;
714 mib[1] = VM_SWAPUSAGE;
716 sw_usage_len = sizeof (struct xsw_usage);
718 if (sysctl (mib, mib_len, &sw_usage, &sw_usage_len, NULL, 0) != 0)
721 /* The returned values are bytes. */
722 swap_submit_gauge (NULL, "used", (gauge_t) sw_usage.xsu_used);
723 swap_submit_gauge (NULL, "free", (gauge_t) sw_usage.xsu_avail);
726 } /* }}} int swap_read */
727 /* #endif VM_SWAPUSAGE */
729 #elif HAVE_LIBKVM_GETSWAPINFO
730 static int swap_read (void) /* {{{ */
732 struct kvm_swap data_s;
742 /* only one structure => only get the grand total, no details */
743 status = kvm_getswapinfo (kvm_obj, &data_s, 1, 0);
747 total = (derive_t) data_s.ksw_total;
748 used = (derive_t) data_s.ksw_used;
750 total *= (derive_t) kvm_pagesize;
751 used *= (derive_t) kvm_pagesize;
755 swap_submit_gauge (NULL, "used", (gauge_t) used);
756 swap_submit_gauge (NULL, "free", (gauge_t) free);
759 } /* }}} int swap_read */
760 /* #endif HAVE_LIBKVM_GETSWAPINFO */
762 #elif HAVE_LIBSTATGRAB
763 static int swap_read (void) /* {{{ */
767 swap = sg_get_swap_stats ();
772 swap_submit_gauge (NULL, "used", (gauge_t) swap->used);
773 swap_submit_gauge (NULL, "free", (gauge_t) swap->free);
776 } /* }}} int swap_read */
777 /* #endif HAVE_LIBSTATGRAB */
780 static int swap_read (void) /* {{{ */
782 if(perfstat_memory_total(NULL, &pmemory, sizeof(perfstat_memory_total_t), 1) < 0)
785 WARNING ("memory plugin: perfstat_memory_total failed: %s",
786 sstrerror (errno, errbuf, sizeof (errbuf)));
789 swap_submit_gauge (NULL, "used", (gauge_t) (pmemory.pgsp_total - pmemory.pgsp_free) * pagesize);
790 swap_submit_gauge (NULL, "free", (gauge_t) pmemory.pgsp_free * pagesize );
793 } /* }}} int swap_read */
794 #endif /* HAVE_PERFSTAT */
796 void module_register (void)
798 plugin_register_config ("swap", swap_config,
799 config_keys, config_keys_num);
800 plugin_register_init ("swap", swap_init);
801 plugin_register_read ("swap", swap_read);
802 } /* void module_register */
804 /* vim: set fdm=marker : */