Added note where to free allocated memory.
[collectd.git] / src / cpu.c
1 /**
2  * collectd - src/cpu.c
3  * Copyright (C) 2005  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; either version 2 of the License, or (at your
8  * option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Florian octo Forster <octo at verplant.org>
21  **/
22
23 #include "collectd.h"
24 #include "common.h"
25 #include "plugin.h"
26 #include "utils_debug.h"
27
28 #define MODULE_NAME "cpu"
29
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_HOST_PRIV_H
37 # include <mach/host_priv.h>
38 #endif
39 #ifdef HAVE_MACH_PROCESSOR_INFO_H
40 # include <mach/processor_info.h>
41 #endif
42 #ifdef HAVE_MACH_PROCESSOR_H
43 # include <mach/processor.h>
44 #endif
45
46 #ifdef HAVE_LIBKSTAT
47 # include <sys/sysinfo.h>
48 #endif /* HAVE_LIBKSTAT */
49
50 #ifdef HAVE_SYSCTLBYNAME
51 # ifdef HAVE_SYS_SYSCTL_H
52 #  include <sys/sysctl.h>
53 # endif
54
55 # ifdef HAVE_SYS_DKSTAT_H
56 #  include <sys/dkstat.h>
57 # endif
58
59 # if !defined(CP_USER) || !defined(CP_NICE) || !defined(CP_SYS) || !defined(CP_INTR) || !defined(CP_IDLE) || !defined(CPUSTATES)
60 #  define CP_USER   0
61 #  define CP_NICE   1
62 #  define CP_SYS    2
63 #  define CP_INTR   3
64 #  define CP_IDLE   4
65 #  define CPUSTATES 5
66 # endif
67 #endif /* HAVE_SYSCTLBYNAME */
68
69 #if defined(PROCESSOR_CPU_LOAD_INFO) || defined(KERNEL_LINUX) || defined(HAVE_LIBKSTAT) || defined(HAVE_SYSCTLBYNAME)
70 # define CPU_HAVE_READ 1
71 #else
72 # define CPU_HAVE_READ 0
73 #endif
74
75 #ifdef PROCESSOR_CPU_LOAD_INFO
76 static mach_port_t port_host;
77 static processor_port_array_t cpu_list;
78 static mach_msg_type_number_t cpu_list_len;
79 /* #endif PROCESSOR_CPU_LOAD_INFO */
80
81 #elif defined(KERNEL_LINUX)
82 /* no variables needed */
83 /* #endif KERNEL_LINUX */
84
85 #elif defined(HAVE_LIBKSTAT)
86 /* colleague tells me that Sun doesn't sell systems with more than 100 or so CPUs.. */
87 # define MAX_NUMCPU 256
88 extern kstat_ctl_t *kc;
89 static kstat_t *ksp[MAX_NUMCPU];
90 static int numcpu;
91 /* #endif HAVE_LIBKSTAT */
92
93 #elif defined(HAVE_SYSCTLBYNAME)
94 static int numcpu;
95 #endif /* HAVE_SYSCTLBYNAME */
96
97 static char *cpu_filename = "cpu-%s.rrd";
98
99 static char *ds_def[] =
100 {
101         "DS:user:COUNTER:"COLLECTD_HEARTBEAT":0:U",
102         "DS:nice:COUNTER:"COLLECTD_HEARTBEAT":0:U",
103         "DS:syst:COUNTER:"COLLECTD_HEARTBEAT":0:U",
104         "DS:idle:COUNTER:"COLLECTD_HEARTBEAT":0:U",
105         "DS:wait:COUNTER:"COLLECTD_HEARTBEAT":0:U",
106         NULL
107 };
108 static int ds_num = 5;
109
110 static void cpu_init (void)
111 {
112 #ifdef PROCESSOR_CPU_LOAD_INFO
113         kern_return_t status;
114
115         port_host = mach_host_self ();
116
117         /* FIXME: Free `cpu_list' if it's not NULL */
118         if ((status = host_processors (port_host, &cpu_list, &cpu_list_len)) != KERN_SUCCESS)
119         {
120                 syslog (LOG_ERR, "cpu-plugin: host_processors returned %i\n", (int) status);
121                 cpu_list_len = 0;
122                 return;
123         }
124
125         DBG ("host_processors returned %i %s", (int) cpu_list_len, cpu_list_len == 1 ? "processor" : "processors");
126         syslog (LOG_INFO, "cpu-plugin: Found %i processor%s.", (int) cpu_list_len, cpu_list_len == 1 ? "" : "s");
127 /* #endif PROCESSOR_CPU_LOAD_INFO */
128
129 #elif defined(HAVE_LIBKSTAT)
130         kstat_t *ksp_chain;
131
132         numcpu = 0;
133
134         if (kc == NULL)
135                 return;
136
137         /* Solaris doesn't count linear.. *sigh* */
138         for (numcpu = 0, ksp_chain = kc->kc_chain;
139                         (numcpu < MAX_NUMCPU) && (ksp_chain != NULL);
140                         ksp_chain = ksp_chain->ks_next)
141                 if (strncmp (ksp_chain->ks_module, "cpu_stat", 8) == 0)
142                         ksp[numcpu++] = ksp_chain;
143 /* #endif HAVE_LIBKSTAT */
144
145 #elif defined (HAVE_SYSCTLBYNAME)
146         size_t numcpu_size;
147
148         numcpu_size = sizeof (numcpu);
149
150         if (sysctlbyname ("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0)
151         {
152                 syslog (LOG_WARNING, "cpu: sysctlbyname: %s", strerror (errno));
153                 return;
154         }
155
156         if (numcpu != 1)
157                 syslog (LOG_NOTICE, "cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
158 #endif
159
160         return;
161 }
162
163 static void cpu_write (char *host, char *inst, char *val)
164 {
165         char file[512];
166         int status;
167
168         status = snprintf (file, 512, cpu_filename, inst);
169         if (status < 1)
170                 return;
171         else if (status >= 512)
172                 return;
173
174         rrd_update_file (host, file, val, ds_def, ds_num);
175 }
176
177 #if CPU_HAVE_READ
178 #define BUFSIZE 512
179 static void cpu_submit (int cpu_num, unsigned long long user,
180                 unsigned long long nice, unsigned long long syst,
181                 unsigned long long idle, unsigned long long wait)
182 {
183         char buf[BUFSIZE];
184         char cpu[16];
185
186         if (snprintf (buf, BUFSIZE, "%u:%llu:%llu:%llu:%llu:%llu", (unsigned int) curtime,
187                                 user, nice, syst, idle, wait) >= BUFSIZE)
188                 return;
189         snprintf (cpu, 16, "%i", cpu_num);
190
191         plugin_submit (MODULE_NAME, cpu, buf);
192 }
193 #undef BUFSIZE
194
195 static void cpu_read (void)
196 {
197 #ifdef PROCESSOR_CPU_LOAD_INFO
198         int cpu;
199
200         kern_return_t status;
201         
202         processor_cpu_load_info_data_t cpu_info;
203         mach_msg_type_number_t         cpu_info_len;
204
205         host_t cpu_host;
206
207         for (cpu = 0; cpu < cpu_list_len; cpu++)
208         {
209                 cpu_host = 0;
210                 cpu_info_len = sizeof (cpu_info);
211
212                 if ((status = processor_info (cpu_list[cpu],
213                                                 PROCESSOR_CPU_LOAD_INFO, &cpu_host,
214                                                 (processor_info_t) &cpu_info, &cpu_info_len)) != KERN_SUCCESS)
215                 {
216                         syslog (LOG_ERR, "processor_info failed with status %i\n", (int) status);
217                         continue;
218                 }
219
220                 if (cpu_info_len < CPU_STATE_MAX)
221                 {
222                         syslog (LOG_ERR, "processor_info returned only %i elements..\n", cpu_info_len);
223                         continue;
224                 }
225
226                 cpu_submit (cpu, cpu_info.cpu_ticks[CPU_STATE_USER],
227                                 cpu_info.cpu_ticks[CPU_STATE_NICE],
228                                 cpu_info.cpu_ticks[CPU_STATE_SYSTEM],
229                                 cpu_info.cpu_ticks[CPU_STATE_IDLE],
230                                 0ULL);
231         }
232 /* #endif PROCESSOR_CPU_LOAD_INFO */
233
234 #elif defined(KERNEL_LINUX)
235 # define BUFSIZE 1024
236         int cpu;
237         unsigned long long user, nice, syst, idle;
238         unsigned long long wait, intr, sitr; /* sitr == soft interrupt */
239         FILE *fh;
240         char buf[BUFSIZE];
241
242         char *fields[9];
243         int numfields;
244
245         if ((fh = fopen ("/proc/stat", "r")) == NULL)
246         {
247                 syslog (LOG_WARNING, "cpu: fopen: %s", strerror (errno));
248                 return;
249         }
250
251         while (fgets (buf, BUFSIZE, fh) != NULL)
252         {
253                 if (strncmp (buf, "cpu", 3))
254                         continue;
255                 if ((buf[3] < '0') || (buf[3] > '9'))
256                         continue;
257
258                 numfields = strsplit (buf, fields, 9);
259                 if (numfields < 5)
260                         continue;
261
262                 cpu = atoi (fields[0] + 3);
263                 user = atoll (fields[1]);
264                 nice = atoll (fields[2]);
265                 syst = atoll (fields[3]);
266                 idle = atoll (fields[4]);
267
268                 if (numfields >= 8)
269                 {
270                         wait = atoll (fields[5]);
271                         intr = atoll (fields[6]);
272                         sitr = atoll (fields[7]);
273
274                         /* I doubt anyone cares about the time spent in
275                          * interrupt handlers.. */
276                         syst += intr + sitr;
277                 }
278                 else
279                 {
280                         wait = 0LL;
281                 }
282
283                 cpu_submit (cpu, user, nice, syst, idle, wait);
284         }
285
286         fclose (fh);
287 #undef BUFSIZE
288 /* #endif defined(KERNEL_LINUX) */
289
290 #elif defined(HAVE_LIBKSTAT)
291         int cpu;
292         unsigned long long user, syst, idle, wait;
293         static cpu_stat_t cs;
294
295         if (kc == NULL)
296                 return;
297
298         for (cpu = 0; cpu < numcpu; cpu++)
299         {
300                 if (kstat_read (kc, ksp[cpu], &cs) == -1)
301                         continue; /* error message? */
302
303                 idle = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_IDLE];
304                 user = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_USER];
305                 syst = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_KERNEL];
306                 wait = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_WAIT];
307
308                 cpu_submit (ksp[cpu]->ks_instance,
309                                 user, 0LL, syst, idle, wait);
310         }
311 /* #endif defined(HAVE_LIBKSTAT) */
312
313 #elif defined(HAVE_SYSCTLBYNAME)
314         long cpuinfo[CPUSTATES];
315         size_t cpuinfo_size;
316
317         cpuinfo_size = sizeof (cpuinfo);
318
319         if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
320         {
321                 syslog (LOG_WARNING, "cpu: sysctlbyname: %s", strerror (errno));
322                 return;
323         }
324
325         cpuinfo[CP_SYS] += cpuinfo[CP_INTR];
326
327         /* FIXME: Instance is always `0' */
328         cpu_submit (0, cpuinfo[CP_USER], cpuinfo[CP_NICE], cpuinfo[CP_SYS], cpuinfo[CP_IDLE], 0LL);
329 #endif
330
331         return;
332 }
333 #else
334 # define cpu_read NULL
335 #endif /* CPU_HAVE_READ */
336
337 void module_register (void)
338 {
339         plugin_register (MODULE_NAME, cpu_init, cpu_read, cpu_write);
340 }
341
342 #undef MODULE_NAME