2a1c53a55ffd67e9793c517d6d4186897cff6251
1 /**
2 * collectd - src/cpu.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_MACH_KERN_RETURN_H
27 # include <mach/kern_return.h>
28 #endif
29 #ifdef HAVE_MACH_MACH_INIT_H
30 # include <mach/mach_init.h>
31 #endif
32 #ifdef HAVE_MACH_HOST_PRIV_H
33 # include <mach/host_priv.h>
34 #endif
35 #if HAVE_MACH_MACH_ERROR_H
36 # include <mach/mach_error.h>
37 #endif
38 #ifdef HAVE_MACH_PROCESSOR_INFO_H
39 # include <mach/processor_info.h>
40 #endif
41 #ifdef HAVE_MACH_PROCESSOR_H
42 # include <mach/processor.h>
43 #endif
44 #ifdef HAVE_MACH_VM_MAP_H
45 # include <mach/vm_map.h>
46 #endif
48 #ifdef HAVE_LIBKSTAT
49 # include <sys/sysinfo.h>
50 #endif /* HAVE_LIBKSTAT */
52 #ifdef HAVE_SYSCTLBYNAME
53 # ifdef HAVE_SYS_SYSCTL_H
54 # include <sys/sysctl.h>
55 # endif
57 # ifdef HAVE_SYS_DKSTAT_H
58 # include <sys/dkstat.h>
59 # endif
61 # if !defined(CP_USER) || !defined(CP_NICE) || !defined(CP_SYS) || !defined(CP_INTR) || !defined(CP_IDLE) || !defined(CPUSTATES)
62 # define CP_USER 0
63 # define CP_NICE 1
64 # define CP_SYS 2
65 # define CP_INTR 3
66 # define CP_IDLE 4
67 # define CPUSTATES 5
68 # endif
69 #endif /* HAVE_SYSCTLBYNAME */
71 #if defined(PROCESSOR_CPU_LOAD_INFO) || defined(KERNEL_LINUX) || defined(HAVE_LIBKSTAT) || defined(HAVE_SYSCTLBYNAME)
72 # define CPU_HAVE_READ 1
73 #else
74 # define CPU_HAVE_READ 0
75 #endif
77 static data_source_t dsrc[1] =
78 {
79 {"value", DS_TYPE_COUNTER, 0, 4294967295.0}
80 };
82 static data_set_t ds =
83 {
84 "cpu", 1, dsrc
85 };
87 #if CPU_HAVE_READ
88 #ifdef PROCESSOR_CPU_LOAD_INFO
89 static mach_port_t port_host;
90 static processor_port_array_t cpu_list;
91 static mach_msg_type_number_t cpu_list_len;
93 #if PROCESSOR_TEMPERATURE
94 static int cpu_temp_retry_counter = 0;
95 static int cpu_temp_retry_step = 1;
96 static int cpu_temp_retry_max = 1;
97 #endif /* PROCESSOR_TEMPERATURE */
98 /* #endif PROCESSOR_CPU_LOAD_INFO */
100 #elif defined(KERNEL_LINUX)
101 /* no variables needed */
102 /* #endif KERNEL_LINUX */
104 #elif defined(HAVE_LIBKSTAT)
105 /* colleague tells me that Sun doesn't sell systems with more than 100 or so CPUs.. */
106 # define MAX_NUMCPU 256
107 extern kstat_ctl_t *kc;
108 static kstat_t *ksp[MAX_NUMCPU];
109 static int numcpu;
110 /* #endif HAVE_LIBKSTAT */
112 #elif defined(HAVE_SYSCTLBYNAME)
113 static int numcpu;
114 #endif /* HAVE_SYSCTLBYNAME */
116 static int init (void)
117 {
118 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
119 kern_return_t status;
121 port_host = mach_host_self ();
123 /* FIXME: Free `cpu_list' if it's not NULL */
124 if ((status = host_processors (port_host, &cpu_list, &cpu_list_len)) != KERN_SUCCESS)
125 {
126 ERROR ("cpu plugin: host_processors returned %i", (int) status);
127 cpu_list_len = 0;
128 return (-1);
129 }
131 DEBUG ("host_processors returned %i %s", (int) cpu_list_len, cpu_list_len == 1 ? "processor" : "processors");
132 INFO ("cpu plugin: Found %i processor%s.", (int) cpu_list_len, cpu_list_len == 1 ? "" : "s");
134 cpu_temp_retry_max = 86400 / interval_g;
135 /* #endif PROCESSOR_CPU_LOAD_INFO */
137 #elif defined(HAVE_LIBKSTAT)
138 kstat_t *ksp_chain;
140 numcpu = 0;
142 if (kc == NULL)
143 return (-1);
145 /* Solaris doesn't count linear.. *sigh* */
146 for (numcpu = 0, ksp_chain = kc->kc_chain;
147 (numcpu < MAX_NUMCPU) && (ksp_chain != NULL);
148 ksp_chain = ksp_chain->ks_next)
149 if (strncmp (ksp_chain->ks_module, "cpu_stat", 8) == 0)
150 ksp[numcpu++] = ksp_chain;
151 /* #endif HAVE_LIBKSTAT */
153 #elif defined (HAVE_SYSCTLBYNAME)
154 size_t numcpu_size;
156 numcpu_size = sizeof (numcpu);
158 if (sysctlbyname ("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0)
159 {
160 char errbuf[1024];
161 WARNING ("cpu plugin: sysctlbyname: %s",
162 sstrerror (errno, errbuf, sizeof (errbuf)));
163 return (-1);
164 }
166 if (numcpu != 1)
167 NOTICE ("cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
168 #endif
170 return (0);
171 } /* int init */
173 static void submit (int cpu_num, const char *type_instance, counter_t value)
174 {
175 value_t values[1];
176 value_list_t vl = VALUE_LIST_INIT;
178 values[0].counter = value;
180 vl.values = values;
181 vl.values_len = 1;
182 vl.time = time (NULL);
183 strcpy (vl.host, hostname_g);
184 strcpy (vl.plugin, "cpu");
185 snprintf (vl.plugin_instance, sizeof (vl.type_instance),
186 "%i", cpu_num);
187 vl.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
188 strcpy (vl.type_instance, type_instance);
190 plugin_dispatch_values ("cpu", &vl);
191 }
193 static int cpu_read (void)
194 {
195 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
196 int cpu;
198 kern_return_t status;
200 #if PROCESSOR_CPU_LOAD_INFO
201 processor_cpu_load_info_data_t cpu_info;
202 mach_msg_type_number_t cpu_info_len;
203 #endif
204 #if PROCESSOR_TEMPERATURE
205 processor_info_data_t cpu_temp;
206 mach_msg_type_number_t cpu_temp_len;
207 #endif
209 host_t cpu_host;
211 for (cpu = 0; cpu < cpu_list_len; cpu++)
212 {
213 #if PROCESSOR_CPU_LOAD_INFO
214 cpu_host = 0;
215 cpu_info_len = PROCESSOR_BASIC_INFO_COUNT;
217 if ((status = processor_info (cpu_list[cpu],
218 PROCESSOR_CPU_LOAD_INFO, &cpu_host,
219 (processor_info_t) &cpu_info, &cpu_info_len)) != KERN_SUCCESS)
220 {
221 ERROR ("cpu plugin: processor_info failed with status %i", (int) status);
222 continue;
223 }
225 if (cpu_info_len < CPU_STATE_MAX)
226 {
227 ERROR ("cpu plugin: processor_info returned only %i elements..", cpu_info_len);
228 continue;
229 }
231 submit (cpu, "user", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
232 submit (cpu, "nice", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
233 submit (cpu, "system", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
234 submit (cpu, "idle", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
235 #endif /* PROCESSOR_CPU_LOAD_INFO */
236 #if PROCESSOR_TEMPERATURE
237 /*
238 * Not all Apple computers do have this ability. To minimize
239 * the messages sent to the syslog we do an exponential
240 * stepback if `processor_info' fails. We still try ~once a day
241 * though..
242 */
243 if (cpu_temp_retry_counter > 0)
244 {
245 cpu_temp_retry_counter--;
246 continue;
247 }
249 cpu_temp_len = PROCESSOR_INFO_MAX;
251 status = processor_info (cpu_list[cpu],
252 PROCESSOR_TEMPERATURE,
253 &cpu_host,
254 cpu_temp, &cpu_temp_len);
255 if (status != KERN_SUCCESS)
256 {
257 ERROR ("cpu plugin: processor_info failed: %s",
258 mach_error_string (status));
260 cpu_temp_retry_counter = cpu_temp_retry_step;
261 cpu_temp_retry_step *= 2;
262 if (cpu_temp_retry_step > cpu_temp_retry_max)
263 cpu_temp_retry_step = cpu_temp_retry_max;
265 continue;
266 }
268 if (cpu_temp_len != 1)
269 {
270 DEBUG ("processor_info (PROCESSOR_TEMPERATURE) returned %i elements..?",
271 (int) cpu_temp_len);
272 continue;
273 }
275 cpu_temp_retry_counter = 0;
276 cpu_temp_retry_step = 1;
278 DEBUG ("cpu_temp = %i", (int) cpu_temp);
279 #endif /* PROCESSOR_TEMPERATURE */
280 }
281 /* #endif PROCESSOR_CPU_LOAD_INFO */
283 #elif defined(KERNEL_LINUX)
284 int cpu;
285 counter_t user, nice, syst, idle;
286 counter_t wait, intr, sitr; /* sitr == soft interrupt */
287 FILE *fh;
288 char buf[1024];
290 char *fields[9];
291 int numfields;
293 static complain_t complain_obj;
295 if ((fh = fopen ("/proc/stat", "r")) == NULL)
296 {
297 char errbuf[1024];
298 plugin_complain (LOG_ERR, &complain_obj, "cpu plugin: "
299 "fopen (/proc/stat) failed: %s",
300 sstrerror (errno, errbuf, sizeof (errbuf)));
301 return (-1);
302 }
304 plugin_relief (LOG_NOTICE, &complain_obj, "cpu plugin: "
305 "fopen (/proc/stat) succeeded.");
307 while (fgets (buf, 1024, fh) != NULL)
308 {
309 if (strncmp (buf, "cpu", 3))
310 continue;
311 if ((buf[3] < '0') || (buf[3] > '9'))
312 continue;
314 numfields = strsplit (buf, fields, 9);
315 if (numfields < 5)
316 continue;
318 cpu = atoi (fields[0] + 3);
319 user = atoll (fields[1]);
320 nice = atoll (fields[2]);
321 syst = atoll (fields[3]);
322 idle = atoll (fields[4]);
324 submit (cpu, "user", user);
325 submit (cpu, "nice", nice);
326 submit (cpu, "system", syst);
327 submit (cpu, "idle", idle);
329 if (numfields >= 8)
330 {
331 wait = atoll (fields[5]);
332 intr = atoll (fields[6]);
333 sitr = atoll (fields[7]);
335 submit (cpu, "wait", wait);
336 submit (cpu, "interrupt", intr);
337 submit (cpu, "softirq", sitr);
339 if (numfields >= 9)
340 submit (cpu, "steal", atoll (fields[8]));
341 }
342 }
344 fclose (fh);
345 /* #endif defined(KERNEL_LINUX) */
347 #elif defined(HAVE_LIBKSTAT)
348 int cpu;
349 counter_t user, syst, idle, wait;
350 static cpu_stat_t cs;
352 if (kc == NULL)
353 return;
355 for (cpu = 0; cpu < numcpu; cpu++)
356 {
357 if (kstat_read (kc, ksp[cpu], &cs) == -1)
358 continue; /* error message? */
360 idle = (counter_t) cs.cpu_sysinfo.cpu[CPU_IDLE];
361 user = (counter_t) cs.cpu_sysinfo.cpu[CPU_USER];
362 syst = (counter_t) cs.cpu_sysinfo.cpu[CPU_KERNEL];
363 wait = (counter_t) cs.cpu_sysinfo.cpu[CPU_WAIT];
365 submit (ksp[cpu]->ks_instance, "user", user);
366 submit (ksp[cpu]->ks_instance, "system", syst);
367 submit (ksp[cpu]->ks_instance, "idle", idle);
368 submit (ksp[cpu]->ks_instance, "wait", wait);
369 }
370 /* #endif defined(HAVE_LIBKSTAT) */
372 #elif defined(HAVE_SYSCTLBYNAME)
373 long cpuinfo[CPUSTATES];
374 size_t cpuinfo_size;
376 static complain_t complain_obj;
378 cpuinfo_size = sizeof (cpuinfo);
380 if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
381 {
382 char errbuf[1024];
383 plugin_complain (LOG_ERR, &complain_obj, "cpu plugin: "
384 "sysctlbyname failed: %s.",
385 sstrerror (errno, errbuf, sizeof (errbuf)));
386 return;
387 }
389 plugin_relief (LOG_NOTICE, &complain_obj, "cpu plugin: "
390 "sysctlbyname succeeded.");
392 cpuinfo[CP_SYS] += cpuinfo[CP_INTR];
394 submit (0, "user", cpuinfo[CP_USER]);
395 submit (0, "nice", cpuinfo[CP_NICE]);
396 submit (0, "system", cpuinfo[CP_SYS]);
397 submit (0, "idle", cpuinfo[CP_IDLE]);
398 #endif
400 return (0);
401 }
402 #endif /* CPU_HAVE_READ */
404 void module_register (modreg_e load)
405 {
406 if (load & MR_DATASETS)
407 plugin_register_data_set (&ds);
409 #if CPU_HAVE_READ
410 if (load & MR_READ)
411 {
412 plugin_register_init ("cpu", init);
413 plugin_register_read ("cpu", cpu_read);
414 }
415 #endif /* CPU_HAVE_READ */
416 } /* void module_register */