1 /**
2 * collectd - src/memory.c
3 * Copyright (C) 2005-2007 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
26 #ifdef HAVE_SYS_SYSCTL_H
27 # include <sys/sysctl.h>
28 #endif
30 #ifdef HAVE_MACH_KERN_RETURN_H
31 # include <mach/kern_return.h>
32 #endif
33 #ifdef HAVE_MACH_MACH_INIT_H
34 # include <mach/mach_init.h>
35 #endif
36 #ifdef HAVE_MACH_MACH_HOST_H
37 # include <mach/mach_host.h>
38 #endif
39 #ifdef HAVE_MACH_HOST_PRIV_H
40 # include <mach/host_priv.h>
41 #endif
42 #ifdef HAVE_MACH_VM_STATISTICS_H
43 # include <mach/vm_statistics.h>
44 #endif
46 #if HAVE_STATGRAB_H
47 # include <statgrab.h>
48 #endif
50 /* vm_statistics_data_t */
51 #if HAVE_HOST_STATISTICS
52 static mach_port_t port_host;
53 static vm_size_t pagesize;
54 /* #endif HAVE_HOST_STATISTICS */
56 #elif HAVE_SYSCTLBYNAME
57 /* no global variables */
58 /* #endif HAVE_SYSCTLBYNAME */
60 #elif KERNEL_LINUX
61 /* no global variables */
62 /* #endif KERNEL_LINUX */
64 #elif HAVE_LIBKSTAT
65 static int pagesize;
66 static kstat_t *ksp;
67 /* #endif HAVE_LIBKSTAT */
69 #elif HAVE_LIBSTATGRAB
70 /* no global variables */
71 /* endif HAVE_LIBSTATGRAB */
73 #else
74 # error "No applicable input method."
75 #endif
77 static int memory_init (void)
78 {
79 #if HAVE_HOST_STATISTICS
80 port_host = mach_host_self ();
81 host_page_size (port_host, &pagesize);
82 /* #endif HAVE_HOST_STATISTICS */
84 #elif HAVE_SYSCTLBYNAME
85 /* no init stuff */
86 /* #endif HAVE_SYSCTLBYNAME */
88 #elif defined(KERNEL_LINUX)
89 /* no init stuff */
90 /* #endif KERNEL_LINUX */
92 #elif defined(HAVE_LIBKSTAT)
93 /* getpagesize(3C) tells me this does not fail.. */
94 pagesize = getpagesize ();
95 if (get_kstat (&ksp, "unix", 0, "system_pages"))
96 ksp = NULL;
97 #endif /* HAVE_LIBKSTAT */
99 return (0);
100 } /* int memory_init */
102 static void memory_submit (const char *type_instance, gauge_t value)
103 {
104 value_t values[1];
105 value_list_t vl = VALUE_LIST_INIT;
107 values[0].gauge = value;
109 vl.values = values;
110 vl.values_len = 1;
111 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
112 sstrncpy (vl.plugin, "memory", sizeof (vl.plugin));
113 sstrncpy (vl.type, "memory", sizeof (vl.type));
114 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
116 plugin_dispatch_values (&vl);
117 }
119 static int memory_read (void)
120 {
121 #if HAVE_HOST_STATISTICS
122 kern_return_t status;
123 vm_statistics_data_t vm_data;
124 mach_msg_type_number_t vm_data_len;
126 long long wired;
127 long long active;
128 long long inactive;
129 long long free;
131 if (!port_host || !pagesize)
132 return (-1);
134 vm_data_len = sizeof (vm_data) / sizeof (natural_t);
135 if ((status = host_statistics (port_host, HOST_VM_INFO,
136 (host_info_t) &vm_data,
137 &vm_data_len)) != KERN_SUCCESS)
138 {
139 ERROR ("memory-plugin: host_statistics failed and returned the value %i", (int) status);
140 return (-1);
141 }
143 /*
144 * From <http://docs.info.apple.com/article.html?artnum=107918>:
145 *
146 * Wired memory
147 * This information can't be cached to disk, so it must stay in RAM.
148 * The amount depends on what applications you are using.
149 *
150 * Active memory
151 * This information is currently in RAM and actively being used.
152 *
153 * Inactive memory
154 * This information is no longer being used and has been cached to
155 * disk, but it will remain in RAM until another application needs
156 * the space. Leaving this information in RAM is to your advantage if
157 * you (or a client of your computer) come back to it later.
158 *
159 * Free memory
160 * This memory is not being used.
161 */
163 wired = vm_data.wire_count * pagesize;
164 active = vm_data.active_count * pagesize;
165 inactive = vm_data.inactive_count * pagesize;
166 free = vm_data.free_count * pagesize;
168 memory_submit ("wired", wired);
169 memory_submit ("active", active);
170 memory_submit ("inactive", inactive);
171 memory_submit ("free", free);
172 /* #endif HAVE_HOST_STATISTICS */
174 #elif HAVE_SYSCTLBYNAME
175 /*
176 * vm.stats.vm.v_page_size: 4096
177 * vm.stats.vm.v_page_count: 246178
178 * vm.stats.vm.v_free_count: 28760
179 * vm.stats.vm.v_wire_count: 37526
180 * vm.stats.vm.v_active_count: 55239
181 * vm.stats.vm.v_inactive_count: 113730
182 * vm.stats.vm.v_cache_count: 10809
183 */
184 char *sysctl_keys[8] =
185 {
186 "vm.stats.vm.v_page_size",
187 "vm.stats.vm.v_page_count",
188 "vm.stats.vm.v_free_count",
189 "vm.stats.vm.v_wire_count",
190 "vm.stats.vm.v_active_count",
191 "vm.stats.vm.v_inactive_count",
192 "vm.stats.vm.v_cache_count",
193 NULL
194 };
195 double sysctl_vals[8];
197 int i;
199 for (i = 0; sysctl_keys[i] != NULL; i++)
200 {
201 int value;
202 size_t value_len = sizeof (value);
204 if (sysctlbyname (sysctl_keys[i], (void *) &value, &value_len,
205 NULL, 0) == 0)
206 {
207 sysctl_vals[i] = value;
208 DEBUG ("memory plugin: %26s: %6i", sysctl_keys[i], sysctl_vals[i]);
209 }
210 else
211 {
212 sysctl_vals[i] = NAN;
213 }
214 } /* for (sysctl_keys) */
216 /* multiply all all page counts with the pagesize */
217 for (i = 1; sysctl_keys[i] != NULL; i++)
218 if (!isnan (sysctl_vals[i]))
219 sysctl_vals[i] *= sysctl_vals[0];
221 memory_submit ("free", sysctl_vals[2]);
222 memory_submit ("wired", sysctl_vals[3]);
223 memory_submit ("active", sysctl_vals[4]);
224 memory_submit ("inactive", sysctl_vals[5]);
225 memory_submit ("cache", sysctl_vals[6]);
226 /* #endif HAVE_SYSCTLBYNAME */
228 #elif KERNEL_LINUX
229 FILE *fh;
230 char buffer[1024];
232 char *fields[8];
233 int numfields;
235 long long mem_used = 0;
236 long long mem_buffered = 0;
237 long long mem_cached = 0;
238 long long mem_free = 0;
240 if ((fh = fopen ("/proc/meminfo", "r")) == NULL)
241 {
242 char errbuf[1024];
243 WARNING ("memory: fopen: %s",
244 sstrerror (errno, errbuf, sizeof (errbuf)));
245 return (-1);
246 }
248 while (fgets (buffer, 1024, fh) != NULL)
249 {
250 long long *val = NULL;
252 if (strncasecmp (buffer, "MemTotal:", 9) == 0)
253 val = &mem_used;
254 else if (strncasecmp (buffer, "MemFree:", 8) == 0)
255 val = &mem_free;
256 else if (strncasecmp (buffer, "Buffers:", 8) == 0)
257 val = &mem_buffered;
258 else if (strncasecmp (buffer, "Cached:", 7) == 0)
259 val = &mem_cached;
260 else
261 continue;
263 numfields = strsplit (buffer, fields, 8);
265 if (numfields < 2)
266 continue;
268 *val = atoll (fields[1]) * 1024LL;
269 }
271 if (fclose (fh))
272 {
273 char errbuf[1024];
274 WARNING ("memory: fclose: %s",
275 sstrerror (errno, errbuf, sizeof (errbuf)));
276 }
278 if (mem_used >= (mem_free + mem_buffered + mem_cached))
279 {
280 mem_used -= mem_free + mem_buffered + mem_cached;
281 memory_submit ("used", mem_used);
282 memory_submit ("buffered", mem_buffered);
283 memory_submit ("cached", mem_cached);
284 memory_submit ("free", mem_free);
285 }
286 /* #endif KERNEL_LINUX */
288 #elif HAVE_LIBKSTAT
289 long long mem_used;
290 long long mem_free;
291 long long mem_lock;
293 if (ksp == NULL)
294 return (-1);
296 mem_used = get_kstat_value (ksp, "pagestotal");
297 mem_free = get_kstat_value (ksp, "pagesfree");
298 mem_lock = get_kstat_value (ksp, "pageslocked");
300 if ((mem_used < 0LL) || (mem_free < 0LL) || (mem_lock < 0LL))
301 return (-1);
302 if (mem_used < (mem_free + mem_lock))
303 return (-1);
305 mem_used -= mem_free + mem_lock;
306 mem_used *= pagesize; /* If this overflows you have some serious */
307 mem_free *= pagesize; /* memory.. Why not call me up and give me */
308 mem_lock *= pagesize; /* some? ;) */
310 memory_submit ("used", mem_used);
311 memory_submit ("free", mem_free);
312 memory_submit ("locked", mem_lock);
313 /* #endif HAVE_LIBKSTAT */
315 #elif HAVE_LIBSTATGRAB
316 sg_mem_stats *ios;
318 if ((ios = sg_get_mem_stats ()) != NULL)
319 {
320 memory_submit ("used", ios->used);
321 memory_submit ("cached", ios->cache);
322 memory_submit ("free", ios->free);
323 }
324 #endif /* HAVE_LIBSTATGRAB */
326 return (0);
327 }
329 void module_register (void)
330 {
331 plugin_register_init ("memory", memory_init);
332 plugin_register_read ("memory", memory_read);
333 } /* void module_register */