Merge branch 'collectd-4.5' into collectd-4.6
[collectd.git] / src / cpu.c
index 62e8145..64ce5df 100644 (file)
--- a/src/cpu.c
+++ b/src/cpu.c
@@ -1,11 +1,12 @@
 /**
  * collectd - src/cpu.c
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005-2009  Florian octo Forster
+ * Copyright (C) 2008       Oleg King
+ * Copyright (C) 2009       Simon Kuhnle
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
+ * Free Software Foundation; only version 2 of the License is applicable.
  *
  * This program is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  * Authors:
  *   Florian octo Forster <octo at verplant.org>
+ *   Oleg King <king2 at kaluga.ru>
+ *   Simon Kuhnle <simon at blarzwurst.de>
  **/
 
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
 
-#define MODULE_NAME "cpu"
+#ifdef HAVE_MACH_KERN_RETURN_H
+# include <mach/kern_return.h>
+#endif
+#ifdef HAVE_MACH_MACH_INIT_H
+# include <mach/mach_init.h>
+#endif
+#ifdef HAVE_MACH_HOST_PRIV_H
+# include <mach/host_priv.h>
+#endif
+#if HAVE_MACH_MACH_ERROR_H
+#  include <mach/mach_error.h>
+#endif
+#ifdef HAVE_MACH_PROCESSOR_INFO_H
+# include <mach/processor_info.h>
+#endif
+#ifdef HAVE_MACH_PROCESSOR_H
+# include <mach/processor.h>
+#endif
+#ifdef HAVE_MACH_VM_MAP_H
+# include <mach/vm_map.h>
+#endif
 
 #ifdef HAVE_LIBKSTAT
 # include <sys/sysinfo.h>
 #endif /* HAVE_LIBKSTAT */
 
-#ifdef HAVE_SYSCTLBYNAME
+#if (defined(HAVE_SYSCTL) && HAVE_SYSCTL) \
+       || (defined(HAVE_SYSCTLBYNAME) && HAVE_SYSCTLBYNAME)
 # ifdef HAVE_SYS_SYSCTL_H
 #  include <sys/sysctl.h>
 # endif
 #  define CP_IDLE   4
 #  define CPUSTATES 5
 # endif
-#endif /* HAVE_SYSCTLBYNAME */
-
-#if defined(KERNEL_LINUX) || defined(HAVE_LIBKSTAT) || defined(HAVE_SYSCTLBYNAME)
-# define CPU_HAVE_READ 1
+#endif /* HAVE_SYSCTL || HAVE_SYSCTLBYNAME */
+
+#if HAVE_SYSCTL
+# if defined(CTL_HW) && defined(HW_NCPU) \
+       && defined(CTL_KERN) && defined(KERN_CPTIME) && defined(CPUSTATES)
+#  define CAN_USE_SYSCTL 1
+# else
+#  define CAN_USE_SYSCTL 0
+# endif
 #else
-# define CPU_HAVE_READ 0
+# define CAN_USE_SYSCTL 0
 #endif
 
-#ifdef HAVE_LIBKSTAT
+#if HAVE_STATGRAB_H
+# include <statgrab.h>
+#endif
+
+#if !PROCESSOR_CPU_LOAD_INFO && !KERNEL_LINUX && !HAVE_LIBKSTAT \
+       && !CAN_USE_SYSCTL && !HAVE_SYSCTLBYNAME && !HAVE_LIBSTATGRAB
+# error "No applicable input method."
+#endif
+
+#ifdef PROCESSOR_CPU_LOAD_INFO
+static mach_port_t port_host;
+static processor_port_array_t cpu_list;
+static mach_msg_type_number_t cpu_list_len;
+
+#if PROCESSOR_TEMPERATURE
+static int cpu_temp_retry_counter = 0;
+static int cpu_temp_retry_step    = 1;
+static int cpu_temp_retry_max     = 1;
+#endif /* PROCESSOR_TEMPERATURE */
+/* #endif PROCESSOR_CPU_LOAD_INFO */
+
+#elif defined(KERNEL_LINUX)
+/* no variables needed */
+/* #endif KERNEL_LINUX */
+
+#elif defined(HAVE_LIBKSTAT)
 /* colleague tells me that Sun doesn't sell systems with more than 100 or so CPUs.. */
 # define MAX_NUMCPU 256
 extern kstat_ctl_t *kc;
 static kstat_t *ksp[MAX_NUMCPU];
 static int numcpu;
-#endif /* HAVE_LIBKSTAT */
+/* #endif HAVE_LIBKSTAT */
+
+#elif CAN_USE_SYSCTL
+static int numcpu;
+/* #endif CAN_USE_SYSCTL */
 
-#ifdef HAVE_SYSCTLBYNAME
+#elif defined(HAVE_SYSCTLBYNAME)
 static int numcpu;
-#endif /* HAVE_SYSCTLBYNAME */
+/* #endif HAVE_SYSCTLBYNAME */
 
-static char *cpu_filename = "cpu-%s.rrd";
+#elif defined(HAVE_LIBSTATGRAB)
+/* no variables needed */
+#endif /* HAVE_LIBSTATGRAB */
 
-static char *ds_def[] =
-{
-       "DS:user:COUNTER:25:0:100",
-       "DS:nice:COUNTER:25:0:100",
-       "DS:syst:COUNTER:25:0:100",
-       "DS:idle:COUNTER:25:0:100",
-       "DS:wait:COUNTER:25:0:100",
-       NULL
-};
-static int ds_num = 5;
-
-static void cpu_init (void)
+static int init (void)
 {
-#ifdef HAVE_LIBKSTAT
+#if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
+       kern_return_t status;
+
+       port_host = mach_host_self ();
+
+       /* FIXME: Free `cpu_list' if it's not NULL */
+       if ((status = host_processors (port_host, &cpu_list, &cpu_list_len)) != KERN_SUCCESS)
+       {
+               ERROR ("cpu plugin: host_processors returned %i", (int) status);
+               cpu_list_len = 0;
+               return (-1);
+       }
+
+       DEBUG ("host_processors returned %i %s", (int) cpu_list_len, cpu_list_len == 1 ? "processor" : "processors");
+       INFO ("cpu plugin: Found %i processor%s.", (int) cpu_list_len, cpu_list_len == 1 ? "" : "s");
+
+       cpu_temp_retry_max = 86400 / interval_g;
+/* #endif PROCESSOR_CPU_LOAD_INFO */
+
+#elif defined(HAVE_LIBKSTAT)
        kstat_t *ksp_chain;
 
        numcpu = 0;
 
        if (kc == NULL)
-               return;
+               return (-1);
 
        /* Solaris doesn't count linear.. *sigh* */
        for (numcpu = 0, ksp_chain = kc->kc_chain;
@@ -98,6 +166,25 @@ static void cpu_init (void)
                        ksp[numcpu++] = ksp_chain;
 /* #endif HAVE_LIBKSTAT */
 
+#elif CAN_USE_SYSCTL
+       size_t numcpu_size;
+       int mib[2] = {CTL_HW, HW_NCPU};
+       int status;
+
+       numcpu = 0;
+       numcpu_size = sizeof (numcpu);
+
+       status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
+                       &numcpu, &numcpu_size, NULL, 0);
+       if (status == -1)
+       {
+               char errbuf[1024];
+               WARNING ("cpu plugin: sysctl: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
+       }
+/* #endif CAN_USE_SYSCTL */
+
 #elif defined (HAVE_SYSCTLBYNAME)
        size_t numcpu_size;
 
@@ -105,69 +192,151 @@ static void cpu_init (void)
 
        if (sysctlbyname ("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0)
        {
-               syslog (LOG_WARNING, "cpu: sysctlbyname: %s", strerror (errno));
-               return;
+               char errbuf[1024];
+               WARNING ("cpu plugin: sysctlbyname: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
        }
 
        if (numcpu != 1)
-               syslog (LOG_NOTICE, "cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
-#endif
+               NOTICE ("cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
+/* #endif HAVE_SYSCTLBYNAME */
 
-       return;
-}
+#elif defined(HAVE_LIBSTATGRAB)
+       /* nothing to initialize */
+#endif /* HAVE_LIBSTATGRAB */
 
-static void cpu_write (char *host, char *inst, char *val)
+       return (0);
+} /* int init */
+
+static void submit (int cpu_num, const char *type_instance, counter_t value)
 {
-       char file[512];
-       int status;
+       value_t values[1];
+       value_list_t vl = VALUE_LIST_INIT;
 
-       status = snprintf (file, 512, cpu_filename, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
+       values[0].counter = value;
 
-       rrd_update_file (host, file, val, ds_def, ds_num);
+       vl.values = values;
+       vl.values_len = 1;
+       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.plugin, "cpu", sizeof (vl.plugin));
+       ssnprintf (vl.plugin_instance, sizeof (vl.type_instance),
+                       "%i", cpu_num);
+       sstrncpy (vl.type, "cpu", sizeof (vl.type));
+       sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
+
+       plugin_dispatch_values (&vl);
 }
 
-#if CPU_HAVE_READ
-#define BUFSIZE 512
-static void cpu_submit (int cpu_num, unsigned long long user,
-               unsigned long long nice, unsigned long long syst,
-               unsigned long long idle, unsigned long long wait)
+static int cpu_read (void)
 {
-       char buf[BUFSIZE];
-       char cpu[16];
+#if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
+       int cpu;
 
-       if (snprintf (buf, BUFSIZE, "%u:%llu:%llu:%llu:%llu:%llu", (unsigned int) curtime,
-                               user, nice, syst, idle, wait) >= BUFSIZE)
-               return;
-       snprintf (cpu, 16, "%i", cpu_num);
+       kern_return_t status;
+       
+#if PROCESSOR_CPU_LOAD_INFO
+       processor_cpu_load_info_data_t cpu_info;
+       mach_msg_type_number_t         cpu_info_len;
+#endif
+#if PROCESSOR_TEMPERATURE
+       processor_info_data_t          cpu_temp;
+       mach_msg_type_number_t         cpu_temp_len;
+#endif
 
-       plugin_submit (MODULE_NAME, cpu, buf);
-}
-#undef BUFSIZE
+       host_t cpu_host;
 
-static void cpu_read (void)
-{
-#ifdef KERNEL_LINUX
-#define BUFSIZE 1024
+       for (cpu = 0; cpu < cpu_list_len; cpu++)
+       {
+#if PROCESSOR_CPU_LOAD_INFO
+               cpu_host = 0;
+               cpu_info_len = PROCESSOR_BASIC_INFO_COUNT;
+
+               if ((status = processor_info (cpu_list[cpu],
+                                               PROCESSOR_CPU_LOAD_INFO, &cpu_host,
+                                               (processor_info_t) &cpu_info, &cpu_info_len)) != KERN_SUCCESS)
+               {
+                       ERROR ("cpu plugin: processor_info failed with status %i", (int) status);
+                       continue;
+               }
+
+               if (cpu_info_len < CPU_STATE_MAX)
+               {
+                       ERROR ("cpu plugin: processor_info returned only %i elements..", cpu_info_len);
+                       continue;
+               }
+
+               submit (cpu, "user", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
+               submit (cpu, "nice", (counter_t) cpu_info.cpu_ticks[CPU_STATE_NICE]);
+               submit (cpu, "system", (counter_t) cpu_info.cpu_ticks[CPU_STATE_SYSTEM]);
+               submit (cpu, "idle", (counter_t) cpu_info.cpu_ticks[CPU_STATE_IDLE]);
+#endif /* PROCESSOR_CPU_LOAD_INFO */
+#if PROCESSOR_TEMPERATURE
+               /*
+                * Not all Apple computers do have this ability. To minimize
+                * the messages sent to the syslog we do an exponential
+                * stepback if `processor_info' fails. We still try ~once a day
+                * though..
+                */
+               if (cpu_temp_retry_counter > 0)
+               {
+                       cpu_temp_retry_counter--;
+                       continue;
+               }
+
+               cpu_temp_len = PROCESSOR_INFO_MAX;
+
+               status = processor_info (cpu_list[cpu],
+                               PROCESSOR_TEMPERATURE,
+                               &cpu_host,
+                               cpu_temp, &cpu_temp_len);
+               if (status != KERN_SUCCESS)
+               {
+                       ERROR ("cpu plugin: processor_info failed: %s",
+                                       mach_error_string (status));
+
+                       cpu_temp_retry_counter = cpu_temp_retry_step;
+                       cpu_temp_retry_step *= 2;
+                       if (cpu_temp_retry_step > cpu_temp_retry_max)
+                               cpu_temp_retry_step = cpu_temp_retry_max;
+
+                       continue;
+               }
+
+               if (cpu_temp_len != 1)
+               {
+                       DEBUG ("processor_info (PROCESSOR_TEMPERATURE) returned %i elements..?",
+                                       (int) cpu_temp_len);
+                       continue;
+               }
+
+               cpu_temp_retry_counter = 0;
+               cpu_temp_retry_step    = 1;
+
+               DEBUG ("cpu_temp = %i", (int) cpu_temp);
+#endif /* PROCESSOR_TEMPERATURE */
+       }
+/* #endif PROCESSOR_CPU_LOAD_INFO */
+
+#elif defined(KERNEL_LINUX)
        int cpu;
-       unsigned long long user, nice, syst, idle;
-       unsigned long long wait, intr, sitr; /* sitr == soft interrupt */
+       counter_t user, nice, syst, idle;
+       counter_t wait, intr, sitr; /* sitr == soft interrupt */
        FILE *fh;
-       char buf[BUFSIZE];
+       char buf[1024];
 
        char *fields[9];
        int numfields;
 
        if ((fh = fopen ("/proc/stat", "r")) == NULL)
        {
-               syslog (LOG_WARNING, "cpu: fopen: %s", strerror (errno));
-               return;
+               char errbuf[1024];
+               ERROR ("cpu plugin: fopen (/proc/stat) failed: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
        }
 
-       while (fgets (buf, BUFSIZE, fh) != NULL)
+       while (fgets (buf, 1024, fh) != NULL)
        {
                if (strncmp (buf, "cpu", 3))
                        continue;
@@ -184,51 +353,118 @@ static void cpu_read (void)
                syst = atoll (fields[3]);
                idle = atoll (fields[4]);
 
+               submit (cpu, "user", user);
+               submit (cpu, "nice", nice);
+               submit (cpu, "system", syst);
+               submit (cpu, "idle", idle);
+
                if (numfields >= 8)
                {
                        wait = atoll (fields[5]);
                        intr = atoll (fields[6]);
                        sitr = atoll (fields[7]);
 
-                       /* I doubt anyone cares about the time spent in
-                        * interrupt handlers.. */
-                       syst += intr + sitr;
-               }
-               else
-               {
-                       wait = 0LL;
-               }
+                       submit (cpu, "wait", wait);
+                       submit (cpu, "interrupt", intr);
+                       submit (cpu, "softirq", sitr);
 
-               cpu_submit (cpu, user, nice, syst, idle, wait);
+                       if (numfields >= 9)
+                               submit (cpu, "steal", atoll (fields[8]));
+               }
        }
 
        fclose (fh);
-#undef BUFSIZE
 /* #endif defined(KERNEL_LINUX) */
 
 #elif defined(HAVE_LIBKSTAT)
        int cpu;
-       unsigned long long user, syst, idle, wait;
+       counter_t user, syst, idle, wait;
        static cpu_stat_t cs;
 
        if (kc == NULL)
-               return;
+               return (-1);
 
        for (cpu = 0; cpu < numcpu; cpu++)
        {
                if (kstat_read (kc, ksp[cpu], &cs) == -1)
                        continue; /* error message? */
 
-               idle = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_IDLE];
-               user = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_USER];
-               syst = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_KERNEL];
-               wait = (unsigned long long) cs.cpu_sysinfo.cpu[CPU_WAIT];
+               idle = (counter_t) cs.cpu_sysinfo.cpu[CPU_IDLE];
+               user = (counter_t) cs.cpu_sysinfo.cpu[CPU_USER];
+               syst = (counter_t) cs.cpu_sysinfo.cpu[CPU_KERNEL];
+               wait = (counter_t) cs.cpu_sysinfo.cpu[CPU_WAIT];
 
-               cpu_submit (ksp[cpu]->ks_instance,
-                               user, 0LL, syst, idle, wait);
+               submit (ksp[cpu]->ks_instance, "user", user);
+               submit (ksp[cpu]->ks_instance, "system", syst);
+               submit (ksp[cpu]->ks_instance, "idle", idle);
+               submit (ksp[cpu]->ks_instance, "wait", wait);
        }
 /* #endif defined(HAVE_LIBKSTAT) */
 
+#elif CAN_USE_SYSCTL
+       uint64_t cpuinfo[numcpu][CPUSTATES];
+       size_t cpuinfo_size;
+       int status;
+       int i;
+
+       if (numcpu < 1)
+       {
+               ERROR ("cpu plugin: Could not determine number of "
+                               "installed CPUs using sysctl(3).");
+               return (-1);
+       }
+
+       memset (cpuinfo, 0, sizeof (cpuinfo));
+
+#if defined(KERN_CPTIME2)
+       if (numcpu > 1) {
+               for (i = 0; i < numcpu; i++) {
+                       int mib[] = {CTL_KERN, KERN_CPTIME2, i};
+
+                       cpuinfo_size = sizeof (cpuinfo[0]);
+
+                       status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
+                                       cpuinfo[i], &cpuinfo_size, NULL, 0);
+                       if (status == -1) {
+                               char errbuf[1024];
+                               ERROR ("cpu plugin: sysctl failed: %s.",
+                                               sstrerror (errno, errbuf, sizeof (errbuf)));
+                               return (-1);
+                       }
+               }
+       }
+       else
+#endif /* defined(KERN_CPTIME2) */
+       {
+               int mib[] = {CTL_KERN, KERN_CPTIME};
+               long cpuinfo_tmp[CPUSTATES];
+
+               cpuinfo_size = sizeof(cpuinfo_tmp);
+
+               status = sysctl (mib, STATIC_ARRAY_SIZE (mib),
+                                       &cpuinfo_tmp, &cpuinfo_size, NULL, 0);
+               if (status == -1)
+               {
+                       char errbuf[1024];
+                       ERROR ("cpu plugin: sysctl failed: %s.",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       return (-1);
+               }
+
+               for(i = 0; i < CPUSTATES; i++) {
+                       cpuinfo[0][i] = cpuinfo_tmp[i];
+               }
+       }
+
+       for (i = 0; i < numcpu; i++) {
+               submit (i, "user",      cpuinfo[i][CP_USER]);
+               submit (i, "nice",      cpuinfo[i][CP_NICE]);
+               submit (i, "system",    cpuinfo[i][CP_SYS]);
+               submit (i, "idle",      cpuinfo[i][CP_IDLE]);
+               submit (i, "interrupt", cpuinfo[i][CP_INTR]);
+       }
+/* #endif CAN_USE_SYSCTL */
+
 #elif defined(HAVE_SYSCTLBYNAME)
        long cpuinfo[CPUSTATES];
        size_t cpuinfo_size;
@@ -237,25 +473,42 @@ static void cpu_read (void)
 
        if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
        {
-               syslog (LOG_WARNING, "cpu: sysctlbyname: %s", strerror (errno));
-               return;
+               char errbuf[1024];
+               ERROR ("cpu plugin: sysctlbyname failed: %s.",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return (-1);
        }
 
-       cpuinfo[CP_SYS] += cpuinfo[CP_INTR];
+       submit (0, "user", cpuinfo[CP_USER]);
+       submit (0, "nice", cpuinfo[CP_NICE]);
+       submit (0, "system", cpuinfo[CP_SYS]);
+       submit (0, "idle", cpuinfo[CP_IDLE]);
+       submit (0, "interrupt", cpuinfo[CP_INTR]);
+/* #endif HAVE_SYSCTLBYNAME */
 
-       /* FIXME: Instance is always `0' */
-       cpu_submit (0, cpuinfo[CP_USER], cpuinfo[CP_NICE], cpuinfo[CP_SYS], cpuinfo[CP_IDLE], 0LL);
-#endif
+#elif defined(HAVE_LIBSTATGRAB)
+       sg_cpu_stats *cs;
+       cs = sg_get_cpu_stats ();
 
-       return;
+       if (cs == NULL)
+       {
+               ERROR ("cpu plugin: sg_get_cpu_stats failed.");
+               return (-1);
+       }
+
+       submit (0, "idle",   (counter_t) cs->idle);
+       submit (0, "nice",   (counter_t) cs->nice);
+       submit (0, "swap",   (counter_t) cs->swap);
+       submit (0, "system", (counter_t) cs->kernel);
+       submit (0, "user",   (counter_t) cs->user);
+       submit (0, "wait",   (counter_t) cs->iowait);
+#endif /* HAVE_LIBSTATGRAB */
+
+       return (0);
 }
-#else
-# define cpu_read NULL
-#endif /* CPU_HAVE_READ */
 
 void module_register (void)
 {
-       plugin_register (MODULE_NAME, cpu_init, cpu_read, cpu_write);
-}
-
-#undef MODULE_NAME
+       plugin_register_init ("cpu", init);
+       plugin_register_read ("cpu", cpu_read);
+} /* void module_register */