Merge branch 'collectd-5.1' into collectd-5.2
[collectd.git] / src / cpu.c
1 /**
2  * collectd - src/cpu.c
3  * Copyright (C) 2005-2010  Florian octo Forster
4  * Copyright (C) 2008       Oleg King
5  * Copyright (C) 2009       Simon Kuhnle
6  * Copyright (C) 2009       Manuel Sanmartin
7  *
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.
11  *
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.
16  *
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
20  *
21  * Authors:
22  *   Florian octo Forster <octo at verplant.org>
23  *   Oleg King <king2 at kaluga.ru>
24  *   Simon Kuhnle <simon at blarzwurst.de>
25  *   Manuel Sanmartin
26  **/
27
28 #include "collectd.h"
29 #include "common.h"
30 #include "plugin.h"
31
32 #ifdef HAVE_MACH_KERN_RETURN_H
33 # include <mach/kern_return.h>
34 #endif
35 #ifdef HAVE_MACH_MACH_INIT_H
36 # include <mach/mach_init.h>
37 #endif
38 #ifdef HAVE_MACH_HOST_PRIV_H
39 # include <mach/host_priv.h>
40 #endif
41 #if HAVE_MACH_MACH_ERROR_H
42 #  include <mach/mach_error.h>
43 #endif
44 #ifdef HAVE_MACH_PROCESSOR_INFO_H
45 # include <mach/processor_info.h>
46 #endif
47 #ifdef HAVE_MACH_PROCESSOR_H
48 # include <mach/processor.h>
49 #endif
50 #ifdef HAVE_MACH_VM_MAP_H
51 # include <mach/vm_map.h>
52 #endif
53
54 #ifdef HAVE_LIBKSTAT
55 # include <sys/sysinfo.h>
56 #endif /* HAVE_LIBKSTAT */
57
58 #if (defined(HAVE_SYSCTL) && HAVE_SYSCTL) \
59         || (defined(HAVE_SYSCTLBYNAME) && HAVE_SYSCTLBYNAME)
60 # ifdef HAVE_SYS_SYSCTL_H
61 #  include <sys/sysctl.h>
62 # endif
63
64 # ifdef HAVE_SYS_DKSTAT_H
65 #  include <sys/dkstat.h>
66 # endif
67
68 # if !defined(CP_USER) || !defined(CP_NICE) || !defined(CP_SYS) || !defined(CP_INTR) || !defined(CP_IDLE) || !defined(CPUSTATES)
69 #  define CP_USER   0
70 #  define CP_NICE   1
71 #  define CP_SYS    2
72 #  define CP_INTR   3
73 #  define CP_IDLE   4
74 #  define CPUSTATES 5
75 # endif
76 #endif /* HAVE_SYSCTL || HAVE_SYSCTLBYNAME */
77
78 #if HAVE_SYSCTL
79 # if defined(CTL_HW) && defined(HW_NCPU) \
80         && defined(CTL_KERN) && defined(KERN_CPTIME) && defined(CPUSTATES)
81 #  define CAN_USE_SYSCTL 1
82 # else
83 #  define CAN_USE_SYSCTL 0
84 # endif
85 #else
86 # define CAN_USE_SYSCTL 0
87 #endif
88
89 #if HAVE_STATGRAB_H
90 # include <statgrab.h>
91 #endif
92
93 # ifdef HAVE_PERFSTAT
94 #  include <sys/protosw.h>
95 #  include <libperfstat.h>
96 # endif /* HAVE_PERFSTAT */
97
98 #if !PROCESSOR_CPU_LOAD_INFO && !KERNEL_LINUX && !HAVE_LIBKSTAT \
99         && !CAN_USE_SYSCTL && !HAVE_SYSCTLBYNAME && !HAVE_LIBSTATGRAB && !HAVE_PERFSTAT
100 # error "No applicable input method."
101 #endif
102
103 #ifdef PROCESSOR_CPU_LOAD_INFO
104 static mach_port_t port_host;
105 static processor_port_array_t cpu_list;
106 static mach_msg_type_number_t cpu_list_len;
107
108 #if PROCESSOR_TEMPERATURE
109 static int cpu_temp_retry_counter = 0;
110 static int cpu_temp_retry_step    = 1;
111 static int cpu_temp_retry_max     = 1;
112 #endif /* PROCESSOR_TEMPERATURE */
113 /* #endif PROCESSOR_CPU_LOAD_INFO */
114
115 #elif defined(KERNEL_LINUX)
116 /* no variables needed */
117 /* #endif KERNEL_LINUX */
118
119 #elif defined(HAVE_LIBKSTAT)
120 /* colleague tells me that Sun doesn't sell systems with more than 100 or so CPUs.. */
121 # define MAX_NUMCPU 256
122 extern kstat_ctl_t *kc;
123 static kstat_t *ksp[MAX_NUMCPU];
124 static int numcpu;
125 /* #endif HAVE_LIBKSTAT */
126
127 #elif CAN_USE_SYSCTL
128 static int numcpu;
129 /* #endif CAN_USE_SYSCTL */
130
131 #elif defined(HAVE_SYSCTLBYNAME)
132 static int numcpu;
133 #  ifdef HAVE_SYSCTL_KERN_CP_TIMES
134 static int maxcpu;
135 #  endif /* HAVE_SYSCTL_KERN_CP_TIMES */
136 /* #endif HAVE_SYSCTLBYNAME */
137
138 #elif defined(HAVE_LIBSTATGRAB)
139 /* no variables needed */
140 /* #endif  HAVE_LIBSTATGRAB */
141
142 #elif defined(HAVE_PERFSTAT)
143 static perfstat_cpu_t *perfcpu;
144 static int numcpu;
145 static int pnumcpu;
146 #endif /* HAVE_PERFSTAT */
147
148 static int init (void)
149 {
150 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
151         kern_return_t status;
152
153         port_host = mach_host_self ();
154
155         /* FIXME: Free `cpu_list' if it's not NULL */
156         if ((status = host_processors (port_host, &cpu_list, &cpu_list_len)) != KERN_SUCCESS)
157         {
158                 ERROR ("cpu plugin: host_processors returned %i", (int) status);
159                 cpu_list_len = 0;
160                 return (-1);
161         }
162
163         DEBUG ("host_processors returned %i %s", (int) cpu_list_len, cpu_list_len == 1 ? "processor" : "processors");
164         INFO ("cpu plugin: Found %i processor%s.", (int) cpu_list_len, cpu_list_len == 1 ? "" : "s");
165
166         cpu_temp_retry_max = 86400 / CDTIME_T_TO_TIME_T (plugin_get_interval ());
167 /* #endif PROCESSOR_CPU_LOAD_INFO */
168
169 #elif defined(HAVE_LIBKSTAT)
170         kstat_t *ksp_chain;
171
172         numcpu = 0;
173
174         if (kc == NULL)
175                 return (-1);
176
177         /* Solaris doesn't count linear.. *sigh* */
178         for (numcpu = 0, ksp_chain = kc->kc_chain;
179                         (numcpu < MAX_NUMCPU) && (ksp_chain != NULL);
180                         ksp_chain = ksp_chain->ks_next)
181                 if (strncmp (ksp_chain->ks_module, "cpu_stat", 8) == 0)
182                         ksp[numcpu++] = ksp_chain;
183 /* #endif HAVE_LIBKSTAT */
184
185 #elif CAN_USE_SYSCTL
186         size_t numcpu_size;
187         int mib[2] = {CTL_HW, HW_NCPU};
188         int status;
189
190         numcpu = 0;
191         numcpu_size = sizeof (numcpu);
192
193         status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
194                         &numcpu, &numcpu_size, NULL, 0);
195         if (status == -1)
196         {
197                 char errbuf[1024];
198                 WARNING ("cpu plugin: sysctl: %s",
199                                 sstrerror (errno, errbuf, sizeof (errbuf)));
200                 return (-1);
201         }
202 /* #endif CAN_USE_SYSCTL */
203
204 #elif defined (HAVE_SYSCTLBYNAME)
205         size_t numcpu_size;
206
207         numcpu_size = sizeof (numcpu);
208
209         if (sysctlbyname ("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0)
210         {
211                 char errbuf[1024];
212                 WARNING ("cpu plugin: sysctlbyname(hw.ncpu): %s",
213                                 sstrerror (errno, errbuf, sizeof (errbuf)));
214                 return (-1);
215         }
216
217 #ifdef HAVE_SYSCTL_KERN_CP_TIMES
218         numcpu_size = sizeof (maxcpu);
219
220         if (sysctlbyname("kern.smp.maxcpus", &maxcpu, &numcpu_size, NULL, 0) < 0)
221         {
222                 char errbuf[1024];
223                 WARNING ("cpu plugin: sysctlbyname(kern.smp.maxcpus): %s",
224                                 sstrerror (errno, errbuf, sizeof (errbuf)));
225                 return (-1);
226         }
227 #else
228         if (numcpu != 1)
229                 NOTICE ("cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
230 #endif
231 /* #endif HAVE_SYSCTLBYNAME */
232
233 #elif defined(HAVE_LIBSTATGRAB)
234         /* nothing to initialize */
235 /* #endif HAVE_LIBSTATGRAB */
236
237 #elif defined(HAVE_PERFSTAT)
238         /* nothing to initialize */
239 #endif /* HAVE_PERFSTAT */
240
241         return (0);
242 } /* int init */
243
244 static void submit (int cpu_num, const char *type_instance, derive_t value)
245 {
246         value_t values[1];
247         value_list_t vl = VALUE_LIST_INIT;
248
249         values[0].derive = value;
250
251         vl.values = values;
252         vl.values_len = 1;
253         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
254         sstrncpy (vl.plugin, "cpu", sizeof (vl.plugin));
255         ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
256                         "%i", cpu_num);
257         sstrncpy (vl.type, "cpu", sizeof (vl.type));
258         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
259
260         plugin_dispatch_values (&vl);
261 }
262
263 static int cpu_read (void)
264 {
265 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
266         int cpu;
267
268         kern_return_t status;
269         
270 #if PROCESSOR_CPU_LOAD_INFO
271         processor_cpu_load_info_data_t cpu_info;
272         mach_msg_type_number_t         cpu_info_len;
273 #endif
274 #if PROCESSOR_TEMPERATURE
275         processor_info_data_t          cpu_temp;
276         mach_msg_type_number_t         cpu_temp_len;
277 #endif
278
279         host_t cpu_host;
280
281         for (cpu = 0; cpu < cpu_list_len; cpu++)
282         {
283 #if PROCESSOR_CPU_LOAD_INFO
284                 cpu_host = 0;
285                 cpu_info_len = PROCESSOR_BASIC_INFO_COUNT;
286
287                 if ((status = processor_info (cpu_list[cpu],
288                                                 PROCESSOR_CPU_LOAD_INFO, &cpu_host,
289                                                 (processor_info_t) &cpu_info, &cpu_info_len)) != KERN_SUCCESS)
290                 {
291                         ERROR ("cpu plugin: processor_info failed with status %i", (int) status);
292                         continue;
293                 }
294
295                 if (cpu_info_len < CPU_STATE_MAX)
296                 {
297                         ERROR ("cpu plugin: processor_info returned only %i elements..", cpu_info_len);
298                         continue;
299                 }
300
301                 submit (cpu, "user", (derive_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
302                 submit (cpu, "nice", (derive_t) cpu_info.cpu_ticks[CPU_STATE_NICE]);
303                 submit (cpu, "system", (derive_t) cpu_info.cpu_ticks[CPU_STATE_SYSTEM]);
304                 submit (cpu, "idle", (derive_t) cpu_info.cpu_ticks[CPU_STATE_IDLE]);
305 #endif /* PROCESSOR_CPU_LOAD_INFO */
306 #if PROCESSOR_TEMPERATURE
307                 /*
308                  * Not all Apple computers do have this ability. To minimize
309                  * the messages sent to the syslog we do an exponential
310                  * stepback if `processor_info' fails. We still try ~once a day
311                  * though..
312                  */
313                 if (cpu_temp_retry_counter > 0)
314                 {
315                         cpu_temp_retry_counter--;
316                         continue;
317                 }
318
319                 cpu_temp_len = PROCESSOR_INFO_MAX;
320
321                 status = processor_info (cpu_list[cpu],
322                                 PROCESSOR_TEMPERATURE,
323                                 &cpu_host,
324                                 cpu_temp, &cpu_temp_len);
325                 if (status != KERN_SUCCESS)
326                 {
327                         ERROR ("cpu plugin: processor_info failed: %s",
328                                         mach_error_string (status));
329
330                         cpu_temp_retry_counter = cpu_temp_retry_step;
331                         cpu_temp_retry_step *= 2;
332                         if (cpu_temp_retry_step > cpu_temp_retry_max)
333                                 cpu_temp_retry_step = cpu_temp_retry_max;
334
335                         continue;
336                 }
337
338                 if (cpu_temp_len != 1)
339                 {
340                         DEBUG ("processor_info (PROCESSOR_TEMPERATURE) returned %i elements..?",
341                                         (int) cpu_temp_len);
342                         continue;
343                 }
344
345                 cpu_temp_retry_counter = 0;
346                 cpu_temp_retry_step    = 1;
347 #endif /* PROCESSOR_TEMPERATURE */
348         }
349 /* #endif PROCESSOR_CPU_LOAD_INFO */
350
351 #elif defined(KERNEL_LINUX)
352         int cpu;
353         derive_t user, nice, syst, idle;
354         derive_t wait, intr, sitr; /* sitr == soft interrupt */
355         FILE *fh;
356         char buf[1024];
357
358         char *fields[9];
359         int numfields;
360
361         if ((fh = fopen ("/proc/stat", "r")) == NULL)
362         {
363                 char errbuf[1024];
364                 ERROR ("cpu plugin: fopen (/proc/stat) failed: %s",
365                                 sstrerror (errno, errbuf, sizeof (errbuf)));
366                 return (-1);
367         }
368
369         while (fgets (buf, 1024, fh) != NULL)
370         {
371                 if (strncmp (buf, "cpu", 3))
372                         continue;
373                 if ((buf[3] < '0') || (buf[3] > '9'))
374                         continue;
375
376                 numfields = strsplit (buf, fields, 9);
377                 if (numfields < 5)
378                         continue;
379
380                 cpu = atoi (fields[0] + 3);
381                 user = atoll (fields[1]);
382                 nice = atoll (fields[2]);
383                 syst = atoll (fields[3]);
384                 idle = atoll (fields[4]);
385
386                 submit (cpu, "user", user);
387                 submit (cpu, "nice", nice);
388                 submit (cpu, "system", syst);
389                 submit (cpu, "idle", idle);
390
391                 if (numfields >= 8)
392                 {
393                         wait = atoll (fields[5]);
394                         intr = atoll (fields[6]);
395                         sitr = atoll (fields[7]);
396
397                         submit (cpu, "wait", wait);
398                         submit (cpu, "interrupt", intr);
399                         submit (cpu, "softirq", sitr);
400
401                         if (numfields >= 9)
402                                 submit (cpu, "steal", atoll (fields[8]));
403                 }
404         }
405
406         fclose (fh);
407 /* #endif defined(KERNEL_LINUX) */
408
409 #elif defined(HAVE_LIBKSTAT)
410         int cpu;
411         derive_t user, syst, idle, wait;
412         static cpu_stat_t cs;
413
414         if (kc == NULL)
415                 return (-1);
416
417         for (cpu = 0; cpu < numcpu; cpu++)
418         {
419                 if (kstat_read (kc, ksp[cpu], &cs) == -1)
420                         continue; /* error message? */
421
422                 idle = (derive_t) cs.cpu_sysinfo.cpu[CPU_IDLE];
423                 user = (derive_t) cs.cpu_sysinfo.cpu[CPU_USER];
424                 syst = (derive_t) cs.cpu_sysinfo.cpu[CPU_KERNEL];
425                 wait = (derive_t) cs.cpu_sysinfo.cpu[CPU_WAIT];
426
427                 submit (ksp[cpu]->ks_instance, "user", user);
428                 submit (ksp[cpu]->ks_instance, "system", syst);
429                 submit (ksp[cpu]->ks_instance, "idle", idle);
430                 submit (ksp[cpu]->ks_instance, "wait", wait);
431         }
432 /* #endif defined(HAVE_LIBKSTAT) */
433
434 #elif CAN_USE_SYSCTL
435         uint64_t cpuinfo[numcpu][CPUSTATES];
436         size_t cpuinfo_size;
437         int status;
438         int i;
439
440         if (numcpu < 1)
441         {
442                 ERROR ("cpu plugin: Could not determine number of "
443                                 "installed CPUs using sysctl(3).");
444                 return (-1);
445         }
446
447         memset (cpuinfo, 0, sizeof (cpuinfo));
448
449 #if defined(KERN_CPTIME2)
450         if (numcpu > 1) {
451                 for (i = 0; i < numcpu; i++) {
452                         int mib[] = {CTL_KERN, KERN_CPTIME2, i};
453
454                         cpuinfo_size = sizeof (cpuinfo[0]);
455
456                         status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
457                                         cpuinfo[i], &cpuinfo_size, NULL, 0);
458                         if (status == -1) {
459                                 char errbuf[1024];
460                                 ERROR ("cpu plugin: sysctl failed: %s.",
461                                                 sstrerror (errno, errbuf, sizeof (errbuf)));
462                                 return (-1);
463                         }
464                 }
465         }
466         else
467 #endif /* defined(KERN_CPTIME2) */
468         {
469                 int mib[] = {CTL_KERN, KERN_CPTIME};
470                 long cpuinfo_tmp[CPUSTATES];
471
472                 cpuinfo_size = sizeof(cpuinfo_tmp);
473
474                 status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
475                                         &cpuinfo_tmp, &cpuinfo_size, NULL, 0);
476                 if (status == -1)
477                 {
478                         char errbuf[1024];
479                         ERROR ("cpu plugin: sysctl failed: %s.",
480                                         sstrerror (errno, errbuf, sizeof (errbuf)));
481                         return (-1);
482                 }
483
484                 for(i = 0; i < CPUSTATES; i++) {
485                         cpuinfo[0][i] = cpuinfo_tmp[i];
486                 }
487         }
488
489         for (i = 0; i < numcpu; i++) {
490                 submit (i, "user",      cpuinfo[i][CP_USER]);
491                 submit (i, "nice",      cpuinfo[i][CP_NICE]);
492                 submit (i, "system",    cpuinfo[i][CP_SYS]);
493                 submit (i, "idle",      cpuinfo[i][CP_IDLE]);
494                 submit (i, "interrupt", cpuinfo[i][CP_INTR]);
495         }
496 /* #endif CAN_USE_SYSCTL */
497 #elif defined(HAVE_SYSCTLBYNAME) && defined(HAVE_SYSCTL_KERN_CP_TIMES)
498         long cpuinfo[maxcpu][CPUSTATES];
499         size_t cpuinfo_size;
500         int i;
501
502         memset (cpuinfo, 0, sizeof (cpuinfo));
503
504         cpuinfo_size = sizeof (cpuinfo);
505         if (sysctlbyname("kern.cp_times", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
506         {
507                 char errbuf[1024];
508                 ERROR ("cpu plugin: sysctlbyname failed: %s.",
509                                 sstrerror (errno, errbuf, sizeof (errbuf)));
510                 return (-1);
511         }
512
513         for (i = 0; i < numcpu; i++) {
514                 submit (i, "user", cpuinfo[i][CP_USER]);
515                 submit (i, "nice", cpuinfo[i][CP_NICE]);
516                 submit (i, "system", cpuinfo[i][CP_SYS]);
517                 submit (i, "idle", cpuinfo[i][CP_IDLE]);
518                 submit (i, "interrupt", cpuinfo[i][CP_INTR]);
519         }
520 /* #endif HAVE_SYSCTL_KERN_CP_TIMES */
521 #elif defined(HAVE_SYSCTLBYNAME)
522         long cpuinfo[CPUSTATES];
523         size_t cpuinfo_size;
524
525         cpuinfo_size = sizeof (cpuinfo);
526
527         if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
528         {
529                 char errbuf[1024];
530                 ERROR ("cpu plugin: sysctlbyname failed: %s.",
531                                 sstrerror (errno, errbuf, sizeof (errbuf)));
532                 return (-1);
533         }
534
535         submit (0, "user", cpuinfo[CP_USER]);
536         submit (0, "nice", cpuinfo[CP_NICE]);
537         submit (0, "system", cpuinfo[CP_SYS]);
538         submit (0, "idle", cpuinfo[CP_IDLE]);
539         submit (0, "interrupt", cpuinfo[CP_INTR]);
540 /* #endif HAVE_SYSCTLBYNAME */
541
542 #elif defined(HAVE_LIBSTATGRAB)
543         sg_cpu_stats *cs;
544         cs = sg_get_cpu_stats ();
545
546         if (cs == NULL)
547         {
548                 ERROR ("cpu plugin: sg_get_cpu_stats failed.");
549                 return (-1);
550         }
551
552         submit (0, "idle",   (derive_t) cs->idle);
553         submit (0, "nice",   (derive_t) cs->nice);
554         submit (0, "swap",   (derive_t) cs->swap);
555         submit (0, "system", (derive_t) cs->kernel);
556         submit (0, "user",   (derive_t) cs->user);
557         submit (0, "wait",   (derive_t) cs->iowait);
558 /* #endif HAVE_LIBSTATGRAB */
559
560 #elif defined(HAVE_PERFSTAT)
561         perfstat_id_t id;
562         int i, cpus;
563
564         numcpu =  perfstat_cpu(NULL, NULL, sizeof(perfstat_cpu_t), 0);
565         if(numcpu == -1)
566         {
567                 char errbuf[1024];
568                 WARNING ("cpu plugin: perfstat_cpu: %s",
569                         sstrerror (errno, errbuf, sizeof (errbuf)));
570                 return (-1);
571         }
572         
573         if (pnumcpu != numcpu || perfcpu == NULL) 
574         {
575                 if (perfcpu != NULL) 
576                         free(perfcpu);
577                 perfcpu = malloc(numcpu * sizeof(perfstat_cpu_t));
578         }
579         pnumcpu = numcpu;
580
581         id.name[0] = '\0';
582         if ((cpus = perfstat_cpu(&id, perfcpu, sizeof(perfstat_cpu_t), numcpu)) < 0)
583         {
584                 char errbuf[1024];
585                 WARNING ("cpu plugin: perfstat_cpu: %s",
586                         sstrerror (errno, errbuf, sizeof (errbuf)));
587                 return (-1);
588         }
589
590         for (i = 0; i < cpus; i++) 
591         {
592                 submit (i, "idle",   (derive_t) perfcpu[i].idle);
593                 submit (i, "system", (derive_t) perfcpu[i].sys);
594                 submit (i, "user",   (derive_t) perfcpu[i].user);
595                 submit (i, "wait",   (derive_t) perfcpu[i].wait);
596         }
597 #endif /* HAVE_PERFSTAT */
598
599         return (0);
600 }
601
602 void module_register (void)
603 {
604         plugin_register_init ("cpu", init);
605         plugin_register_read ("cpu", cpu_read);
606 } /* void module_register */