2 * collectd - src/memory.c
3 * Copyright (C) 2005-2014 Florian octo Forster
4 * Copyright (C) 2009 Simon Kuhnle
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 collectd.org>
22 * Simon Kuhnle <simon at blarzwurst.de>
31 #ifdef HAVE_SYS_SYSCTL_H
32 # include <sys/sysctl.h>
34 #ifdef HAVE_SYS_VMMETER_H
35 # include <sys/vmmeter.h>
38 #ifdef HAVE_MACH_KERN_RETURN_H
39 # include <mach/kern_return.h>
41 #ifdef HAVE_MACH_MACH_INIT_H
42 # include <mach/mach_init.h>
44 #ifdef HAVE_MACH_MACH_HOST_H
45 # include <mach/mach_host.h>
47 #ifdef HAVE_MACH_HOST_PRIV_H
48 # include <mach/host_priv.h>
50 #ifdef HAVE_MACH_VM_STATISTICS_H
51 # include <mach/vm_statistics.h>
55 # include <statgrab.h>
59 # include <sys/protosw.h>
60 # include <libperfstat.h>
61 #endif /* HAVE_PERFSTAT */
63 /* vm_statistics_data_t */
64 #if HAVE_HOST_STATISTICS
65 static mach_port_t port_host;
66 static vm_size_t pagesize;
67 /* #endif HAVE_HOST_STATISTICS */
69 #elif HAVE_SYSCTLBYNAME
70 /* no global variables */
71 /* #endif HAVE_SYSCTLBYNAME */
74 /* no global variables */
75 /* #endif KERNEL_LINUX */
81 /* #endif HAVE_LIBKSTAT */
85 /* #endif HAVE_SYSCTL */
87 #elif HAVE_LIBSTATGRAB
88 /* no global variables */
89 /* endif HAVE_LIBSTATGRAB */
92 /* endif HAVE_PERFSTAT */
94 # error "No applicable input method."
97 static _Bool values_absolute = 1;
98 static _Bool values_percentage = 0;
100 static int memory_config (oconfig_item_t *ci) /* {{{ */
102 for (int i = 0; i < ci->children_num; i++)
104 oconfig_item_t *child = ci->children + i;
105 if (strcasecmp ("ValuesAbsolute", child->key) == 0)
106 cf_util_get_boolean (child, &values_absolute);
107 else if (strcasecmp ("ValuesPercentage", child->key) == 0)
108 cf_util_get_boolean (child, &values_percentage);
110 ERROR ("memory plugin: Invalid configuration option: "
111 "\"%s\".", child->key);
115 } /* }}} int memory_config */
117 static int memory_init (void)
119 #if HAVE_HOST_STATISTICS
120 port_host = mach_host_self ();
121 host_page_size (port_host, &pagesize);
122 /* #endif HAVE_HOST_STATISTICS */
124 #elif HAVE_SYSCTLBYNAME
126 /* #endif HAVE_SYSCTLBYNAME */
128 #elif defined(KERNEL_LINUX)
130 /* #endif KERNEL_LINUX */
132 #elif defined(HAVE_LIBKSTAT)
133 /* getpagesize(3C) tells me this does not fail.. */
134 pagesize = getpagesize ();
135 if (get_kstat (&ksp, "unix", 0, "system_pages") != 0)
140 if (get_kstat (&ksz, "zfs", 0, "arcstats") != 0)
146 /* #endif HAVE_LIBKSTAT */
149 pagesize = getpagesize ();
152 ERROR ("memory plugin: Invalid pagesize: %i", pagesize);
155 /* #endif HAVE_SYSCTL */
157 #elif HAVE_LIBSTATGRAB
159 /* #endif HAVE_LIBSTATGRAB */
162 pagesize = getpagesize ();
163 #endif /* HAVE_PERFSTAT */
165 } /* int memory_init */
167 #define MEMORY_SUBMIT(...) do { \
168 if (values_absolute) \
169 plugin_dispatch_multivalue (vl, 0, DS_TYPE_GAUGE, __VA_ARGS__, NULL); \
170 if (values_percentage) \
171 plugin_dispatch_multivalue (vl, 1, DS_TYPE_GAUGE, __VA_ARGS__, NULL); \
174 static int memory_read_internal (value_list_t *vl)
176 #if HAVE_HOST_STATISTICS
177 kern_return_t status;
178 vm_statistics_data_t vm_data;
179 mach_msg_type_number_t vm_data_len;
186 if (!port_host || !pagesize)
189 vm_data_len = sizeof (vm_data) / sizeof (natural_t);
190 if ((status = host_statistics (port_host, HOST_VM_INFO,
191 (host_info_t) &vm_data,
192 &vm_data_len)) != KERN_SUCCESS)
194 ERROR ("memory-plugin: host_statistics failed and returned the value %i", (int) status);
199 * From <http://docs.info.apple.com/article.html?artnum=107918>:
202 * This information can't be cached to disk, so it must stay in RAM.
203 * The amount depends on what applications you are using.
206 * This information is currently in RAM and actively being used.
209 * This information is no longer being used and has been cached to
210 * disk, but it will remain in RAM until another application needs
211 * the space. Leaving this information in RAM is to your advantage if
212 * you (or a client of your computer) come back to it later.
215 * This memory is not being used.
218 wired = (gauge_t) (((uint64_t) vm_data.wire_count) * ((uint64_t) pagesize));
219 active = (gauge_t) (((uint64_t) vm_data.active_count) * ((uint64_t) pagesize));
220 inactive = (gauge_t) (((uint64_t) vm_data.inactive_count) * ((uint64_t) pagesize));
221 free = (gauge_t) (((uint64_t) vm_data.free_count) * ((uint64_t) pagesize));
223 MEMORY_SUBMIT ("wired", wired,
225 "inactive", inactive,
227 /* #endif HAVE_HOST_STATISTICS */
229 #elif HAVE_SYSCTLBYNAME
231 * vm.stats.vm.v_page_size: 4096
232 * vm.stats.vm.v_page_count: 246178
233 * vm.stats.vm.v_free_count: 28760
234 * vm.stats.vm.v_wire_count: 37526
235 * vm.stats.vm.v_active_count: 55239
236 * vm.stats.vm.v_inactive_count: 113730
237 * vm.stats.vm.v_cache_count: 10809
239 const char *sysctl_keys[8] =
241 "vm.stats.vm.v_page_size",
242 "vm.stats.vm.v_page_count",
243 "vm.stats.vm.v_free_count",
244 "vm.stats.vm.v_wire_count",
245 "vm.stats.vm.v_active_count",
246 "vm.stats.vm.v_inactive_count",
247 "vm.stats.vm.v_cache_count",
250 double sysctl_vals[8];
252 for (int i = 0; sysctl_keys[i] != NULL; i++)
255 size_t value_len = sizeof (value);
257 if (sysctlbyname (sysctl_keys[i], (void *) &value, &value_len,
260 sysctl_vals[i] = value;
261 DEBUG ("memory plugin: %26s: %g", sysctl_keys[i], sysctl_vals[i]);
265 sysctl_vals[i] = NAN;
267 } /* for (sysctl_keys) */
269 /* multiply all all page counts with the pagesize */
270 for (int i = 1; sysctl_keys[i] != NULL; i++)
271 if (!isnan (sysctl_vals[i]))
272 sysctl_vals[i] *= sysctl_vals[0];
274 MEMORY_SUBMIT ("free", (gauge_t) sysctl_vals[2],
275 "wired", (gauge_t) sysctl_vals[3],
276 "active", (gauge_t) sysctl_vals[4],
277 "inactive", (gauge_t) sysctl_vals[5],
278 "cache", (gauge_t) sysctl_vals[6]);
279 /* #endif HAVE_SYSCTLBYNAME */
288 _Bool detailed_slab_info = 0;
290 gauge_t mem_total = 0;
291 gauge_t mem_used = 0;
292 gauge_t mem_buffered = 0;
293 gauge_t mem_cached = 0;
294 gauge_t mem_free = 0;
295 gauge_t mem_slab_total = 0;
296 gauge_t mem_slab_reclaimable = 0;
297 gauge_t mem_slab_unreclaimable = 0;
299 if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
302 WARNING ("memory: fopen: %s",
303 sstrerror (errno, errbuf, sizeof (errbuf)));
307 while (fgets (buffer, sizeof (buffer), fh) != NULL)
311 if (strncasecmp (buffer, "MemTotal:", 9) == 0)
313 else if (strncasecmp (buffer, "MemFree:", 8) == 0)
315 else if (strncasecmp (buffer, "Buffers:", 8) == 0)
317 else if (strncasecmp (buffer, "Cached:", 7) == 0)
319 else if (strncasecmp (buffer, "Slab:", 5) == 0)
320 val = &mem_slab_total;
321 else if (strncasecmp (buffer, "SReclaimable:", 13) == 0) {
322 val = &mem_slab_reclaimable;
323 detailed_slab_info = 1;
325 else if (strncasecmp (buffer, "SUnreclaim:", 11) == 0) {
326 val = &mem_slab_unreclaimable;
327 detailed_slab_info = 1;
332 numfields = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
336 *val = 1024.0 * atof (fields[1]);
342 WARNING ("memory: fclose: %s",
343 sstrerror (errno, errbuf, sizeof (errbuf)));
346 if (mem_total < (mem_free + mem_buffered + mem_cached + mem_slab_total))
349 mem_used = mem_total - (mem_free + mem_buffered + mem_cached + mem_slab_total);
351 /* SReclaimable and SUnreclaim were introduced in kernel 2.6.19
352 * They sum up to the value of Slab, which is available on older & newer
353 * kernels. So SReclaimable/SUnreclaim are submitted if available, and Slab
355 if (detailed_slab_info)
356 MEMORY_SUBMIT ("used", mem_used,
357 "buffered", mem_buffered,
358 "cached", mem_cached,
360 "slab_unrecl", mem_slab_unreclaimable,
361 "slab_recl", mem_slab_reclaimable);
363 MEMORY_SUBMIT ("used", mem_used,
364 "buffered", mem_buffered,
365 "cached", mem_cached,
367 "slab", mem_slab_total);
368 /* #endif KERNEL_LINUX */
371 /* Most of the additions here were taken as-is from the k9toolkit from
372 * Brendan Gregg and are subject to change I guess */
390 mem_used = get_kstat_value (ksp, "pagestotal");
391 mem_free = get_kstat_value (ksp, "pagesfree");
392 mem_lock = get_kstat_value (ksp, "pageslocked");
393 arcsize = get_kstat_value (ksz, "size");
394 pp_kernel = get_kstat_value (ksp, "pp_kernel");
395 physmem = get_kstat_value (ksp, "physmem");
396 availrmem = get_kstat_value (ksp, "availrmem");
401 if ((mem_used < 0LL) || (mem_free < 0LL) || (mem_lock < 0LL))
403 WARNING ("memory plugin: one of used, free or locked is negative.");
407 mem_unus = physmem - mem_used;
409 if (mem_used < (mem_free + mem_lock))
411 /* source: http://wesunsolve.net/bugid/id/4909199
412 * this seems to happen when swap space is small, e.g. 2G on a 32G system
413 * we will make some assumptions here
414 * educated solaris internals help welcome here */
415 DEBUG ("memory plugin: pages total is smaller than \"free\" "
416 "+ \"locked\". This is probably due to small "
418 mem_free = availrmem;
423 mem_used -= mem_free + mem_lock;
426 /* mem_kern is accounted for in mem_lock */
427 if (pp_kernel < mem_lock)
429 mem_kern = pp_kernel;
430 mem_lock -= pp_kernel;
438 mem_used *= pagesize; /* If this overflows you have some serious */
439 mem_free *= pagesize; /* memory.. Why not call me up and give me */
440 mem_lock *= pagesize; /* some? ;) */
441 mem_kern *= pagesize; /* it's 2011 RAM is cheap */
442 mem_unus *= pagesize;
446 MEMORY_SUBMIT ("used", (gauge_t) mem_used,
447 "free", (gauge_t) mem_free,
448 "locked", (gauge_t) mem_lock,
449 "kernel", (gauge_t) mem_kern,
450 "arc", (gauge_t) arcsize,
451 "unusable", (gauge_t) mem_unus);
452 /* #endif HAVE_LIBKSTAT */
455 int mib[] = {CTL_VM, VM_METER};
456 struct vmtotal vmtotal = { 0 };
458 gauge_t mem_inactive;
462 size = sizeof (vmtotal);
464 if (sysctl (mib, 2, &vmtotal, &size, NULL, 0) < 0) {
466 WARNING ("memory plugin: sysctl failed: %s",
467 sstrerror (errno, errbuf, sizeof (errbuf)));
471 assert (pagesize > 0);
472 mem_active = (gauge_t) (vmtotal.t_arm * pagesize);
473 mem_inactive = (gauge_t) ((vmtotal.t_rm - vmtotal.t_arm) * pagesize);
474 mem_free = (gauge_t) (vmtotal.t_free * pagesize);
476 MEMORY_SUBMIT ("active", mem_active,
477 "inactive", mem_inactive,
479 /* #endif HAVE_SYSCTL */
481 #elif HAVE_LIBSTATGRAB
484 ios = sg_get_mem_stats ();
488 MEMORY_SUBMIT ("used", (gauge_t) ios->used,
489 "cached", (gauge_t) ios->cache,
490 "free", (gauge_t) ios->free);
491 /* #endif HAVE_LIBSTATGRAB */
494 perfstat_memory_total_t pmemory = { 0 };
496 if (perfstat_memory_total(NULL, &pmemory, sizeof(pmemory), 1) < 0)
499 WARNING ("memory plugin: perfstat_memory_total failed: %s",
500 sstrerror (errno, errbuf, sizeof (errbuf)));
504 /* Unfortunately, the AIX documentation is not very clear on how these
505 * numbers relate to one another. The only thing is states explcitly
507 * real_total = real_process + real_free + numperm + real_system
509 * Another segmentation, which would be closer to the numbers reported
510 * by the "svmon" utility, would be:
511 * real_total = real_free + real_inuse
512 * real_inuse = "active" + real_pinned + numperm
514 MEMORY_SUBMIT ("free", (gauge_t) (pmemory.real_free * pagesize),
515 "cached", (gauge_t) (pmemory.numperm * pagesize),
516 "system", (gauge_t) (pmemory.real_system * pagesize),
517 "user", (gauge_t) (pmemory.real_process * pagesize));
518 #endif /* HAVE_PERFSTAT */
521 } /* }}} int memory_read_internal */
523 static int memory_read (void) /* {{{ */
526 value_list_t vl = VALUE_LIST_INIT;
529 vl.values_len = STATIC_ARRAY_SIZE (v);
530 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
531 sstrncpy (vl.plugin, "memory", sizeof (vl.plugin));
532 sstrncpy (vl.type, "memory", sizeof (vl.type));
535 return (memory_read_internal (&vl));
536 } /* }}} int memory_read */
538 void module_register (void)
540 plugin_register_complex_config ("memory", memory_config);
541 plugin_register_init ("memory", memory_init);
542 plugin_register_read ("memory", memory_read);
543 } /* void module_register */