src/cpu.c

   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  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25
  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
  47
  48 #ifdef HAVE_LIBKSTAT
  49 # include <sys/sysinfo.h>
  50 #endif /* HAVE_LIBKSTAT */
  51
  52 #ifdef HAVE_SYSCTLBYNAME
  53 # ifdef HAVE_SYS_SYSCTL_H
  54 #  include <sys/sysctl.h>
  55 # endif
  56
  57 # ifdef HAVE_SYS_DKSTAT_H
  58 #  include <sys/dkstat.h>
  59 # endif
  60
  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 */
  70
  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
  76
  77 static data_source_t dsrc[1] =
  78 {
  79         {"value", DS_TYPE_COUNTER, 0, 4294967295.0}
  80 };
  81
  82 static data_set_t ds =
  83 {
  84         "cpu", 1, dsrc
  85 };
  86
  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;
  92
  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 */
  99
 100 #elif defined(KERNEL_LINUX)
 101 /* no variables needed */
 102 /* #endif KERNEL_LINUX */
 103
 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 */
 111
 112 #elif defined(HAVE_SYSCTLBYNAME)
 113 static int numcpu;
 114 #endif /* HAVE_SYSCTLBYNAME */
 115
 116 static int init (void)
 117 {
 118 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
 119         kern_return_t status;
 120         int collectd_step;
 121
 122         port_host = mach_host_self ();
 123
 124         /* FIXME: Free `cpu_list' if it's not NULL */
 125         if ((status = host_processors (port_host, &cpu_list, &cpu_list_len)) != KERN_SUCCESS)
 126         {
 127                 ERROR ("cpu plugin: host_processors returned %i", (int) status);
 128                 cpu_list_len = 0;
 129                 return (-1);
 130         }
 131
 132         DEBUG ("host_processors returned %i %s", (int) cpu_list_len, cpu_list_len == 1 ? "processor" : "processors");
 133         INFO ("cpu plugin: Found %i processor%s.", (int) cpu_list_len, cpu_list_len == 1 ? "" : "s");
 134
 135         collectd_step = atoi (COLLECTD_STEP);
 136         if ((collectd_step > 0) && (collectd_step <= 86400))
 137                 cpu_temp_retry_max = 86400 / collectd_step;
 138
 139 /* #endif PROCESSOR_CPU_LOAD_INFO */
 140
 141 #elif defined(HAVE_LIBKSTAT)
 142         kstat_t *ksp_chain;
 143
 144         numcpu = 0;
 145
 146         if (kc == NULL)
 147                 return (-1);
 148
 149         /* Solaris doesn't count linear.. *sigh* */
 150         for (numcpu = 0, ksp_chain = kc->kc_chain;
 151                         (numcpu < MAX_NUMCPU) && (ksp_chain != NULL);
 152                         ksp_chain = ksp_chain->ks_next)
 153                 if (strncmp (ksp_chain->ks_module, "cpu_stat", 8) == 0)
 154                         ksp[numcpu++] = ksp_chain;
 155 /* #endif HAVE_LIBKSTAT */
 156
 157 #elif defined (HAVE_SYSCTLBYNAME)
 158         size_t numcpu_size;
 159
 160         numcpu_size = sizeof (numcpu);
 161
 162         if (sysctlbyname ("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0)
 163         {
 164                 WARNING ("cpu: sysctlbyname: %s", strerror (errno));
 165                 return (-1);
 166         }
 167
 168         if (numcpu != 1)
 169                 NOTICE ("cpu: Only one processor supported when using `sysctlbyname' (found %i)", numcpu);
 170 #endif
 171
 172         return (0);
 173 } /* int init */
 174
 175 static void submit (int cpu_num, const char *type_instance, counter_t value)
 176 {
 177         value_t values[1];
 178         value_list_t vl = VALUE_LIST_INIT;
 179
 180         values[0].counter = value;
 181
 182         vl.values = values;
 183         vl.values_len = 1;
 184         vl.time = time (NULL);
 185         strcpy (vl.host, hostname_g);
 186         strcpy (vl.plugin, "cpu");
 187         snprintf (vl.plugin_instance, sizeof (vl.type_instance),
 188                         "%i", cpu_num);
 189         vl.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
 190         strcpy (vl.type_instance, type_instance);
 191
 192         plugin_dispatch_values ("cpu", &vl);
 193 }
 194
 195 static int cpu_read (void)
 196 {
 197 #if PROCESSOR_CPU_LOAD_INFO || PROCESSOR_TEMPERATURE
 198         int cpu;
 199
 200         kern_return_t status;
 201
 202 #if PROCESSOR_CPU_LOAD_INFO
 203         processor_cpu_load_info_data_t cpu_info;
 204         mach_msg_type_number_t         cpu_info_len;
 205 #endif
 206 #if PROCESSOR_TEMPERATURE
 207         processor_info_data_t          cpu_temp;
 208         mach_msg_type_number_t         cpu_temp_len;
 209 #endif
 210
 211         host_t cpu_host;
 212
 213         for (cpu = 0; cpu < cpu_list_len; cpu++)
 214         {
 215 #if PROCESSOR_CPU_LOAD_INFO
 216                 cpu_host = 0;
 217                 cpu_info_len = PROCESSOR_BASIC_INFO_COUNT;
 218
 219                 if ((status = processor_info (cpu_list[cpu],
 220                                                 PROCESSOR_CPU_LOAD_INFO, &cpu_host,
 221                                                 (processor_info_t) &cpu_info, &cpu_info_len)) != KERN_SUCCESS)
 222                 {
 223                         ERROR ("cpu plugin: processor_info failed with status %i", (int) status);
 224                         continue;
 225                 }
 226
 227                 if (cpu_info_len < CPU_STATE_MAX)
 228                 {
 229                         ERROR ("cpu plugin: processor_info returned only %i elements..", cpu_info_len);
 230                         continue;
 231                 }
 232
 233                 submit (cpu, "user", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
 234                 submit (cpu, "nice", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
 235                 submit (cpu, "system", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
 236                 submit (cpu, "idle", (counter_t) cpu_info.cpu_ticks[CPU_STATE_USER]);
 237 #endif /* PROCESSOR_CPU_LOAD_INFO */
 238 #if PROCESSOR_TEMPERATURE
 239                 /*
 240                  * Not all Apple computers do have this ability. To minimize
 241                  * the messages sent to the syslog we do an exponential
 242                  * stepback if `processor_info' fails. We still try ~once a day
 243                  * though..
 244                  */
 245                 if (cpu_temp_retry_counter > 0)
 246                 {
 247                         cpu_temp_retry_counter--;
 248                         continue;
 249                 }
 250
 251                 cpu_temp_len = PROCESSOR_INFO_MAX;
 252
 253                 status = processor_info (cpu_list[cpu],
 254                                 PROCESSOR_TEMPERATURE,
 255                                 &cpu_host,
 256                                 cpu_temp, &cpu_temp_len);
 257                 if (status != KERN_SUCCESS)
 258                 {
 259                         ERROR ("cpu plugin: processor_info failed: %s",
 260                                         mach_error_string (status));
 261
 262                         cpu_temp_retry_counter = cpu_temp_retry_step;
 263                         cpu_temp_retry_step *= 2;
 264                         if (cpu_temp_retry_step > cpu_temp_retry_max)
 265                                 cpu_temp_retry_step = cpu_temp_retry_max;
 266
 267                         continue;
 268                 }
 269
 270                 if (cpu_temp_len != 1)
 271                 {
 272                         DEBUG ("processor_info (PROCESSOR_TEMPERATURE) returned %i elements..?",
 273                                         (int) cpu_temp_len);
 274                         continue;
 275                 }
 276
 277                 cpu_temp_retry_counter = 0;
 278                 cpu_temp_retry_step    = 1;
 279
 280                 DEBUG ("cpu_temp = %i", (int) cpu_temp);
 281 #endif /* PROCESSOR_TEMPERATURE */
 282         }
 283 /* #endif PROCESSOR_CPU_LOAD_INFO */
 284
 285 #elif defined(KERNEL_LINUX)
 286         int cpu;
 287         counter_t user, nice, syst, idle;
 288         counter_t wait, intr, sitr; /* sitr == soft interrupt */
 289         FILE *fh;
 290         char buf[1024];
 291
 292         char *fields[9];
 293         int numfields;
 294
 295         static complain_t complain_obj;
 296
 297         if ((fh = fopen ("/proc/stat", "r")) == NULL)
 298         {
 299                 plugin_complain (LOG_ERR, &complain_obj, "cpu plugin: "
 300                                 "fopen (/proc/stat) failed: %s",
 301                                 strerror (errno));
 302                 return (-1);
 303         }
 304
 305         plugin_relief (LOG_NOTICE, &complain_obj, "cpu plugin: "
 306                         "fopen (/proc/stat) succeeded.");
 307
 308         while (fgets (buf, 1024, fh) != NULL)
 309         {
 310                 if (strncmp (buf, "cpu", 3))
 311                         continue;
 312                 if ((buf[3] < '0') || (buf[3] > '9'))
 313                         continue;
 314
 315                 numfields = strsplit (buf, fields, 9);
 316                 if (numfields < 5)
 317                         continue;
 318
 319                 cpu = atoi (fields[0] + 3);
 320                 user = atoll (fields[1]);
 321                 nice = atoll (fields[2]);
 322                 syst = atoll (fields[3]);
 323                 idle = atoll (fields[4]);
 324
 325                 submit (cpu, "user", user);
 326                 submit (cpu, "nice", nice);
 327                 submit (cpu, "system", syst);
 328                 submit (cpu, "idle", idle);
 329
 330                 if (numfields >= 8)
 331                 {
 332                         wait = atoll (fields[5]);
 333                         intr = atoll (fields[6]);
 334                         sitr = atoll (fields[7]);
 335
 336                         submit (cpu, "wait", wait);
 337                         submit (cpu, "interrupt", intr);
 338                         submit (cpu, "softirq", sitr);
 339                 }
 340         }
 341
 342         fclose (fh);
 343 /* #endif defined(KERNEL_LINUX) */
 344
 345 #elif defined(HAVE_LIBKSTAT)
 346         int cpu;
 347         counter_t user, syst, idle, wait;
 348         static cpu_stat_t cs;
 349
 350         if (kc == NULL)
 351                 return;
 352
 353         for (cpu = 0; cpu < numcpu; cpu++)
 354         {
 355                 if (kstat_read (kc, ksp[cpu], &cs) == -1)
 356                         continue; /* error message? */
 357
 358                 idle = (counter_t) cs.cpu_sysinfo.cpu[CPU_IDLE];
 359                 user = (counter_t) cs.cpu_sysinfo.cpu[CPU_USER];
 360                 syst = (counter_t) cs.cpu_sysinfo.cpu[CPU_KERNEL];
 361                 wait = (counter_t) cs.cpu_sysinfo.cpu[CPU_WAIT];
 362
 363                 submit (ksp[cpu]->ks_instance, "user", user);
 364                 submit (ksp[cpu]->ks_instance, "system", syst);
 365                 submit (ksp[cpu]->ks_instance, "idle", idle);
 366                 submit (ksp[cpu]->ks_instance, "wait", wait);
 367         }
 368 /* #endif defined(HAVE_LIBKSTAT) */
 369
 370 #elif defined(HAVE_SYSCTLBYNAME)
 371         long cpuinfo[CPUSTATES];
 372         size_t cpuinfo_size;
 373
 374         static complain_t complain_obj;
 375
 376         cpuinfo_size = sizeof (cpuinfo);
 377
 378         if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0)
 379         {
 380                 plugin_complain (LOG_ERR, &complain_obj, "cpu plugin: "
 381                                 "sysctlbyname failed: %s.",
 382                                 strerror (errno));
 383                 return;
 384         }
 385
 386         plugin_relief (LOG_NOTICE, &complain_obj, "cpu plugin: "
 387                         "sysctlbyname succeeded.");
 388
 389         cpuinfo[CP_SYS] += cpuinfo[CP_INTR];
 390
 391         submit (0, "user", cpuinfo[CP_USER]);
 392         submit (0, "nice", cpuinfo[CP_NICE]);
 393         submit (0, "system", cpuinfo[CP_SYS]);
 394         submit (0, "idle", cpuinfo[CP_IDLE]);
 395 #endif
 396
 397         return (0);
 398 }
 399 #endif /* CPU_HAVE_READ */
 400
 401 void module_register (void)
 402 {
 403         plugin_register_data_set (&ds);
 404
 405 #if CPU_HAVE_READ
 406         plugin_register_init ("cpu", init);
 407         plugin_register_read ("cpu", cpu_read);
 408 #endif /* CPU_HAVE_READ */
 409 }