src/cpu.c

   1 /**
   2  * collectd - src/cpu.c
   3  * Copyright (C) 2005-2014  Florian octo Forster
   4  * Copyright (C) 2008       Oleg King
   5  * Copyright (C) 2009       Simon Kuhnle
   6  * Copyright (C) 2009       Manuel Sanmartin
   7  * Copyright (C) 2013-2014  Pierre-Yves Ritschard
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; only version 2 of the License is applicable.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21  *
  22  * Authors:
  23  *   Florian octo Forster <octo at collectd.org>
  24  *   Oleg King <king2 at kaluga.ru>
  25  *   Simon Kuhnle <simon at blarzwurst.de>
  26  *   Manuel Sanmartin
  27  *   Pierre-Yves Ritschard <pyr at spootnik.org>
  28  **/
  29
  30 #include "collectd.h"
  31
  32 #include "common.h"
  33 #include "plugin.h"
  34
  35 #ifdef HAVE_MACH_KERN_RETURN_H
  36 #include <mach/kern_return.h>
  37 #endif
  38 #ifdef HAVE_MACH_MACH_INIT_H
  39 #include <mach/mach_init.h>
  40 #endif
  41 #ifdef HAVE_MACH_HOST_PRIV_H
  42 #include <mach/host_priv.h>
  43 #endif
  44 #if HAVE_MACH_MACH_ERROR_H
  45 #include <mach/mach_error.h>
  46 #endif
  47 #ifdef HAVE_MACH_PROCESSOR_INFO_H
  48 #include <mach/processor_info.h>
  49 #endif
  50 #ifdef HAVE_MACH_PROCESSOR_H
  51 #include <mach/processor.h>
  52 #endif
  53 #ifdef HAVE_MACH_VM_MAP_H
  54 #include <mach/vm_map.h>
  55 #endif
  56
  57 #ifdef HAVE_LIBKSTAT
  58 #include <sys/sysinfo.h>
  59 #endif /* HAVE_LIBKSTAT */
  60
  61 #if (defined(HAVE_SYSCTL) && HAVE_SYSCTL) ||                                   \
  62     (defined(HAVE_SYSCTLBYNAME) && HAVE_SYSCTLBYNAME)
  63 #ifdef HAVE_SYS_SYSCTL_H
  64 #include <sys/sysctl.h>
  65 #endif
  66
  67 #ifdef HAVE_SYS_DKSTAT_H
  68 #include <sys/dkstat.h>
  69 #endif
  70
  71 #if !defined(CP_USER) || !defined(CP_NICE) || !defined(CP_SYS) ||              \
  72     !defined(CP_INTR) || !defined(CP_IDLE) || !defined(CPUSTATES)
  73 #define CP_USER 0
  74 #define CP_NICE 1
  75 #define CP_SYS 2
  76 #define CP_INTR 3
  77 #define CP_IDLE 4
  78 #define CPUSTATES 5
  79 #endif
  80 #endif /* HAVE_SYSCTL || HAVE_SYSCTLBYNAME */
  81
  82 #if HAVE_SYSCTL
  83 #if defined(CTL_HW) && defined(HW_NCPU) && defined(CTL_KERN) &&                \
  84     defined(KERN_CPTIME) && defined(CPUSTATES)
  85 #define CAN_USE_SYSCTL 1
  86 #else
  87 #define CAN_USE_SYSCTL 0
  88 #endif
  89 #else
  90 #define CAN_USE_SYSCTL 0
  91 #endif
  92
  93 #define COLLECTD_CPU_STATE_USER 0
  94 #define COLLECTD_CPU_STATE_SYSTEM 1
  95 #define COLLECTD_CPU_STATE_WAIT 2
  96 #define COLLECTD_CPU_STATE_NICE 3
  97 #define COLLECTD_CPU_STATE_SWAP 4
  98 #define COLLECTD_CPU_STATE_INTERRUPT 5
  99 #define COLLECTD_CPU_STATE_SOFTIRQ 6
 100 #define COLLECTD_CPU_STATE_STEAL 7
 101 #define COLLECTD_CPU_STATE_GUEST 8
 102 #define COLLECTD_CPU_STATE_GUEST_NICE 9
 103 #define COLLECTD_CPU_STATE_IDLE 10
 104 #define COLLECTD_CPU_STATE_ACTIVE 11 /* sum of (!idle) */
 105 #define COLLECTD_CPU_STATE_MAX 12    /* #states */
 106
 107 #if HAVE_STATGRAB_H
 108 #include <statgrab.h>
 109 #endif
 110
 111 #ifdef HAVE_PERFSTAT
 112 #include <libperfstat.h>
 113 #include <sys/protosw.h>
 114 #endif /* HAVE_PERFSTAT */
 115
 116 #if !PROCESSOR_CPU_LOAD_INFO && !KERNEL_LINUX && !HAVE_LIBKSTAT &&             \
 117     !CAN_USE_SYSCTL && !HAVE_SYSCTLBYNAME && !HAVE_LIBSTATGRAB &&              \
 118     !HAVE_PERFSTAT
 119 #error "No applicable input method."
 120 #endif
 121
 122 static const char *cpu_state_names[] = {
 123     "user",    "system", "wait",  "nice",       "swap", "interrupt",
 124     "softirq", "steal",  "guest", "guest_nice", "idle", "active"};
 125
 126 #ifdef PROCESSOR_CPU_LOAD_INFO
 127 static mach_port_t port_host;
 128 static processor_port_array_t cpu_list;
 129 static mach_msg_type_number_t cpu_list_len;
 130 /* #endif PROCESSOR_CPU_LOAD_INFO */
 131
 132 #elif defined(KERNEL_LINUX)
 133 /* no variables needed */
 134 /* #endif KERNEL_LINUX */
 135
 136 #elif defined(HAVE_LIBKSTAT)
 137 /* colleague tells me that Sun doesn't sell systems with more than 100 or so
 138  * CPUs.. */
 139 #define MAX_NUMCPU 256
 140 extern kstat_ctl_t *kc;
 141 static kstat_t *ksp[MAX_NUMCPU];
 142 static int numcpu;
 143 /* #endif HAVE_LIBKSTAT */
 144
 145 #elif CAN_USE_SYSCTL
 146 static int numcpu;
 147 /* #endif CAN_USE_SYSCTL */
 148
 149 #elif defined(HAVE_SYSCTLBYNAME)
 150 static int numcpu;
 151 #ifdef HAVE_SYSCTL_KERN_CP_TIMES
 152 static int maxcpu;
 153 #endif /* HAVE_SYSCTL_KERN_CP_TIMES */
 154 /* #endif HAVE_SYSCTLBYNAME */
 155
 156 #elif defined(HAVE_LIBSTATGRAB)
 157 /* no variables needed */
 158 /* #endif  HAVE_LIBSTATGRAB */
 159
 160 #elif defined(HAVE_PERFSTAT)
 161 #define TOTAL_IDLE 0
 162 #define TOTAL_USER 1
 163 #define TOTAL_SYS 2
 164 #define TOTAL_WAIT 3
 165 #define TOTAL_STAT_NUM 4
 166 static value_to_rate_state_t total_conv[TOTAL_STAT_NUM];
 167 static perfstat_cpu_t *perfcpu;
 168 static int numcpu;
 169 static int pnumcpu;
 170 #endif /* HAVE_PERFSTAT */
 171
 172 #define RATE_ADD(sum, val)                                                     \
 173   do {                                                                         \
 174     if (isnan(sum))                                                            \
 175       (sum) = (val);                                                           \
 176     else if (!isnan(val))                                                      \
 177       (sum) += (val);                                                          \
 178   } while (0)
 179
 180 struct cpu_state_s {
 181   value_to_rate_state_t conv;
 182   gauge_t rate;
 183   _Bool has_value;
 184 };
 185 typedef struct cpu_state_s cpu_state_t;
 186
 187 static cpu_state_t *cpu_states = NULL;
 188 static size_t cpu_states_num = 0; /* #cpu_states allocated */
 189
 190 /* Highest CPU number in the current iteration. Used by the dispatch logic to
 191  * determine how many CPUs there were. Reset to 0 by cpu_reset(). */
 192 static size_t global_cpu_num = 0;
 193
 194 static _Bool report_by_cpu = 1;
 195 static _Bool report_by_state = 1;
 196 static _Bool report_percent = 0;
 197 static _Bool report_num_cpu = 0;
 198 static _Bool report_guest = 0;
 199 static _Bool subtract_guest = 1;
 200
 201 static const char *config_keys[] = {"ReportByCpu",      "ReportByState",
 202                                     "ReportNumCpu",     "ValuesPercentage",
 203                                     "ReportGuestState", "SubtractGuestState"};
 204 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
 205
 206 static int cpu_config(char const *key, char const *value) /* {{{ */
 207 {
 208   if (strcasecmp(key, "ReportByCpu") == 0)
 209     report_by_cpu = IS_TRUE(value) ? 1 : 0;
 210   else if (strcasecmp(key, "ValuesPercentage") == 0)
 211     report_percent = IS_TRUE(value) ? 1 : 0;
 212   else if (strcasecmp(key, "ReportByState") == 0)
 213     report_by_state = IS_TRUE(value) ? 1 : 0;
 214   else if (strcasecmp(key, "ReportNumCpu") == 0)
 215     report_num_cpu = IS_TRUE(value) ? 1 : 0;
 216   else if (strcasecmp(key, "ReportGuestState") == 0)
 217     report_guest = IS_TRUE(value) ? 1 : 0;
 218   else if (strcasecmp(key, "SubtractGuestState") == 0)
 219     subtract_guest = IS_TRUE(value) ? 1 : 0;
 220   else
 221     return -1;
 222
 223   return 0;
 224 } /* }}} int cpu_config */
 225
 226 static int init(void) {
 227 #if PROCESSOR_CPU_LOAD_INFO
 228   kern_return_t status;
 229
 230   port_host = mach_host_self();
 231
 232   status = host_processors(port_host, &cpu_list, &cpu_list_len);
 233   if (status == KERN_INVALID_ARGUMENT) {
 234     ERROR("cpu plugin: Don't have a privileged host control port. "
 235           "The most common cause for this problem is "
 236           "that collectd is running without root "
 237           "privileges, which are required to read CPU "
 238           "load information. "
 239           "<https://collectd.org/bugs/22>");
 240     cpu_list_len = 0;
 241     return -1;
 242   }
 243   if (status != KERN_SUCCESS) {
 244     ERROR("cpu plugin: host_processors() failed with status %d.", (int)status);
 245     cpu_list_len = 0;
 246     return -1;
 247   }
 248
 249   INFO("cpu plugin: Found %i processor%s.", (int)cpu_list_len,
 250        cpu_list_len == 1 ? "" : "s");
 251 /* #endif PROCESSOR_CPU_LOAD_INFO */
 252
 253 #elif defined(HAVE_LIBKSTAT)
 254   kstat_t *ksp_chain;
 255
 256   numcpu = 0;
 257
 258   if (kc == NULL)
 259     return -1;
 260
 261   /* Solaris doesn't count linear.. *sigh* */
 262   for (numcpu = 0, ksp_chain = kc->kc_chain;
 263        (numcpu < MAX_NUMCPU) && (ksp_chain != NULL);
 264        ksp_chain = ksp_chain->ks_next)
 265     if (strncmp(ksp_chain->ks_module, "cpu_stat", 8) == 0)
 266       ksp[numcpu++] = ksp_chain;
 267 /* #endif HAVE_LIBKSTAT */
 268
 269 #elif CAN_USE_SYSCTL
 270   size_t numcpu_size;
 271   int mib[2] = {CTL_HW, HW_NCPU};
 272   int status;
 273
 274   numcpu = 0;
 275   numcpu_size = sizeof(numcpu);
 276
 277   status = sysctl(mib, STATIC_ARRAY_SIZE(mib), &numcpu, &numcpu_size, NULL, 0);
 278   if (status == -1) {
 279     WARNING("cpu plugin: sysctl: %s", STRERRNO);
 280     return -1;
 281   }
 282 /* #endif CAN_USE_SYSCTL */
 283
 284 #elif defined(HAVE_SYSCTLBYNAME)
 285   size_t numcpu_size;
 286
 287   numcpu_size = sizeof(numcpu);
 288
 289   if (sysctlbyname("hw.ncpu", &numcpu, &numcpu_size, NULL, 0) < 0) {
 290     WARNING("cpu plugin: sysctlbyname(hw.ncpu): %s", STRERRNO);
 291     return -1;
 292   }
 293
 294 #ifdef HAVE_SYSCTL_KERN_CP_TIMES
 295   numcpu_size = sizeof(maxcpu);
 296
 297   if (sysctlbyname("kern.smp.maxcpus", &maxcpu, &numcpu_size, NULL, 0) < 0) {
 298     WARNING("cpu plugin: sysctlbyname(kern.smp.maxcpus): %s", STRERRNO);
 299     return -1;
 300   }
 301 #else
 302   if (numcpu != 1)
 303     NOTICE("cpu: Only one processor supported when using `sysctlbyname' (found "
 304            "%i)",
 305            numcpu);
 306 #endif
 307 /* #endif HAVE_SYSCTLBYNAME */
 308
 309 #elif defined(HAVE_LIBSTATGRAB)
 310 /* nothing to initialize */
 311 /* #endif HAVE_LIBSTATGRAB */
 312
 313 #elif defined(HAVE_PERFSTAT)
 314 /* nothing to initialize */
 315 #endif /* HAVE_PERFSTAT */
 316
 317   return 0;
 318 } /* int init */
 319
 320 static void submit_value(int cpu_num, int cpu_state, const char *type,
 321                          value_t value) {
 322   value_list_t vl = VALUE_LIST_INIT;
 323
 324   vl.values = &value;
 325   vl.values_len = 1;
 326
 327   sstrncpy(vl.plugin, "cpu", sizeof(vl.plugin));
 328   sstrncpy(vl.type, type, sizeof(vl.type));
 329   sstrncpy(vl.type_instance, cpu_state_names[cpu_state],
 330            sizeof(vl.type_instance));
 331
 332   if (cpu_num >= 0) {
 333     snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%i", cpu_num);
 334   }
 335   plugin_dispatch_values(&vl);
 336 }
 337
 338 static void submit_percent(int cpu_num, int cpu_state, gauge_t value) {
 339   /* This function is called for all known CPU states, but each read
 340    * method will only report a subset. The remaining states are left as
 341    * NAN and we ignore them here. */
 342   if (isnan(value))
 343     return;
 344
 345   submit_value(cpu_num, cpu_state, "percent", (value_t){.gauge = value});
 346 }
 347
 348 static void submit_derive(int cpu_num, int cpu_state, derive_t value) {
 349   submit_value(cpu_num, cpu_state, "cpu", (value_t){.derive = value});
 350 }
 351
 352 /* Takes the zero-index number of a CPU and makes sure that the module-global
 353  * cpu_states buffer is large enough. Returne ENOMEM on erorr. */
 354 static int cpu_states_alloc(size_t cpu_num) /* {{{ */
 355 {
 356   cpu_state_t *tmp;
 357   size_t sz;
 358
 359   sz = (((size_t)cpu_num) + 1) * COLLECTD_CPU_STATE_MAX;
 360   assert(sz > 0);
 361
 362   /* We already have enough space. */
 363   if (cpu_states_num >= sz)
 364     return 0;
 365
 366   tmp = realloc(cpu_states, sz * sizeof(*cpu_states));
 367   if (tmp == NULL) {
 368     ERROR("cpu plugin: realloc failed.");
 369     return ENOMEM;
 370   }
 371   cpu_states = tmp;
 372   tmp = cpu_states + cpu_states_num;
 373
 374   memset(tmp, 0, (sz - cpu_states_num) * sizeof(*cpu_states));
 375   cpu_states_num = sz;
 376   return 0;
 377 } /* }}} cpu_states_alloc */
 378
 379 static cpu_state_t *get_cpu_state(size_t cpu_num, size_t state) /* {{{ */
 380 {
 381   size_t index = ((cpu_num * COLLECTD_CPU_STATE_MAX) + state);
 382
 383   if (index >= cpu_states_num)
 384     return NULL;
 385
 386   return &cpu_states[index];
 387 } /* }}} cpu_state_t *get_cpu_state */
 388
 389 #if defined(HAVE_PERFSTAT) /* {{{ */
 390 /* populate global aggregate cpu rate */
 391 static int total_rate(gauge_t *sum_by_state, size_t state, derive_t d,
 392                       value_to_rate_state_t *conv, cdtime_t now) {
 393   gauge_t rate = NAN;
 394   int status =
 395       value_to_rate(&rate, (value_t){.derive = d}, DS_TYPE_DERIVE, now, conv);
 396   if (status != 0)
 397     return status;
 398
 399   sum_by_state[state] = rate;
 400
 401   if (state != COLLECTD_CPU_STATE_IDLE)
 402     RATE_ADD(sum_by_state[COLLECTD_CPU_STATE_ACTIVE], sum_by_state[state]);
 403   return 0;
 404 }
 405 #endif /* }}} HAVE_PERFSTAT */
 406
 407 /* Populates the per-CPU COLLECTD_CPU_STATE_ACTIVE rate and the global
 408  * rate_by_state
 409  * array. */
 410 static void aggregate(gauge_t *sum_by_state) /* {{{ */
 411 {
 412   for (size_t state = 0; state < COLLECTD_CPU_STATE_MAX; state++)
 413     sum_by_state[state] = NAN;
 414
 415   for (size_t cpu_num = 0; cpu_num < global_cpu_num; cpu_num++) {
 416     cpu_state_t *this_cpu_states = get_cpu_state(cpu_num, 0);
 417
 418     this_cpu_states[COLLECTD_CPU_STATE_ACTIVE].rate = NAN;
 419
 420     for (size_t state = 0; state < COLLECTD_CPU_STATE_ACTIVE; state++) {
 421       if (!this_cpu_states[state].has_value)
 422         continue;
 423
 424       RATE_ADD(sum_by_state[state], this_cpu_states[state].rate);
 425       if (state != COLLECTD_CPU_STATE_IDLE)
 426         RATE_ADD(this_cpu_states[COLLECTD_CPU_STATE_ACTIVE].rate,
 427                  this_cpu_states[state].rate);
 428     }
 429
 430     if (!isnan(this_cpu_states[COLLECTD_CPU_STATE_ACTIVE].rate))
 431       this_cpu_states[COLLECTD_CPU_STATE_ACTIVE].has_value = 1;
 432
 433     RATE_ADD(sum_by_state[COLLECTD_CPU_STATE_ACTIVE],
 434              this_cpu_states[COLLECTD_CPU_STATE_ACTIVE].rate);
 435   }
 436
 437 #if defined(HAVE_PERFSTAT) /* {{{ */
 438   cdtime_t now = cdtime();
 439   perfstat_cpu_total_t cputotal = {0};
 440
 441   if (!perfstat_cpu_total(NULL, &cputotal, sizeof(cputotal), 1)) {
 442     WARNING("cpu plugin: perfstat_cpu_total: %s", STRERRNO);
 443     return;
 444   }
 445
 446   /* Reset COLLECTD_CPU_STATE_ACTIVE */
 447   sum_by_state[COLLECTD_CPU_STATE_ACTIVE] = NAN;
 448
 449   /* Physical Processor Utilization */
 450   total_rate(sum_by_state, COLLECTD_CPU_STATE_IDLE, (derive_t)cputotal.pidle,
 451              &total_conv[TOTAL_IDLE], now);
 452   total_rate(sum_by_state, COLLECTD_CPU_STATE_USER, (derive_t)cputotal.puser,
 453              &total_conv[TOTAL_USER], now);
 454   total_rate(sum_by_state, COLLECTD_CPU_STATE_SYSTEM, (derive_t)cputotal.psys,
 455              &total_conv[TOTAL_SYS], now);
 456   total_rate(sum_by_state, COLLECTD_CPU_STATE_WAIT, (derive_t)cputotal.pwait,
 457              &total_conv[TOTAL_WAIT], now);
 458 #endif /* }}} HAVE_PERFSTAT */
 459 } /* }}} void aggregate */
 460
 461 /* Commits (dispatches) the values for one CPU or the global aggregation.
 462  * cpu_num is the index of the CPU to be committed or -1 in case of the global
 463  * aggregation. rates is a pointer to COLLECTD_CPU_STATE_MAX gauge_t values
 464  * holding the
 465  * current rate; each rate may be NAN. Calculates the percentage of each state
 466  * and dispatches the metric. */
 467 static void cpu_commit_one(int cpu_num, /* {{{ */
 468                            gauge_t rates[static COLLECTD_CPU_STATE_MAX]) {
 469   gauge_t sum;
 470
 471   sum = rates[COLLECTD_CPU_STATE_ACTIVE];
 472   RATE_ADD(sum, rates[COLLECTD_CPU_STATE_IDLE]);
 473
 474   if (!report_by_state) {
 475     gauge_t percent = 100.0 * rates[COLLECTD_CPU_STATE_ACTIVE] / sum;
 476     submit_percent(cpu_num, COLLECTD_CPU_STATE_ACTIVE, percent);
 477     return;
 478   }
 479
 480   for (size_t state = 0; state < COLLECTD_CPU_STATE_ACTIVE; state++) {
 481     gauge_t percent = 100.0 * rates[state] / sum;
 482     submit_percent(cpu_num, state, percent);
 483   }
 484 } /* }}} void cpu_commit_one */
 485
 486 /* Commits the number of cores */
 487 static void cpu_commit_num_cpu(gauge_t value) /* {{{ */
 488 {
 489   value_list_t vl = VALUE_LIST_INIT;
 490
 491   vl.values = &(value_t){.gauge = value};
 492   vl.values_len = 1;
 493
 494   sstrncpy(vl.plugin, "cpu", sizeof(vl.plugin));
 495   sstrncpy(vl.type, "count", sizeof(vl.type));
 496
 497   plugin_dispatch_values(&vl);
 498 } /* }}} void cpu_commit_num_cpu */
 499
 500 /* Resets the internal aggregation. This is called by the read callback after
 501  * each iteration / after each call to cpu_commit(). */
 502 static void cpu_reset(void) /* {{{ */
 503 {
 504   for (size_t i = 0; i < cpu_states_num; i++)
 505     cpu_states[i].has_value = 0;
 506
 507   global_cpu_num = 0;
 508 } /* }}} void cpu_reset */
 509
 510 /* Legacy behavior: Dispatches the raw derive values without any aggregation. */
 511 static void cpu_commit_without_aggregation(void) /* {{{ */
 512 {
 513   for (int state = 0; state < COLLECTD_CPU_STATE_ACTIVE; state++) {
 514     for (size_t cpu_num = 0; cpu_num < global_cpu_num; cpu_num++) {
 515       cpu_state_t *s = get_cpu_state(cpu_num, state);
 516
 517       if (!s->has_value)
 518         continue;
 519
 520       submit_derive((int)cpu_num, (int)state, s->conv.last_value.derive);
 521     }
 522   }
 523 } /* }}} void cpu_commit_without_aggregation */
 524
 525 /* Aggregates the internal state and dispatches the metrics. */
 526 static void cpu_commit(void) /* {{{ */
 527 {
 528   gauge_t global_rates[COLLECTD_CPU_STATE_MAX] = {
 529       NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN /* Batman! */
 530   };
 531
 532   if (report_num_cpu)
 533     cpu_commit_num_cpu((gauge_t)global_cpu_num);
 534
 535   if (report_by_state && report_by_cpu && !report_percent) {
 536     cpu_commit_without_aggregation();
 537     return;
 538   }
 539
 540   aggregate(global_rates);
 541
 542   if (!report_by_cpu) {
 543     cpu_commit_one(-1, global_rates);
 544     return;
 545   }
 546
 547   for (size_t cpu_num = 0; cpu_num < global_cpu_num; cpu_num++) {
 548     cpu_state_t *this_cpu_states = get_cpu_state(cpu_num, 0);
 549     gauge_t local_rates[COLLECTD_CPU_STATE_MAX] = {
 550         NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN, NAN};
 551
 552     for (size_t state = 0; state < COLLECTD_CPU_STATE_MAX; state++)
 553       if (this_cpu_states[state].has_value)
 554         local_rates[state] = this_cpu_states[state].rate;
 555
 556     cpu_commit_one((int)cpu_num, local_rates);
 557   }
 558 } /* }}} void cpu_commit */
 559
 560 /* Adds a derive value to the internal state. This should be used by each read
 561  * function for each state. At the end of the iteration, the read function
 562  * should call cpu_commit(). */
 563 static int cpu_stage(size_t cpu_num, size_t state, derive_t d,
 564                      cdtime_t now) /* {{{ */
 565 {
 566   int status;
 567   cpu_state_t *s;
 568   gauge_t rate = NAN;
 569   value_t val = {.derive = d};
 570
 571   if (state >= COLLECTD_CPU_STATE_ACTIVE)
 572     return EINVAL;
 573
 574   status = cpu_states_alloc(cpu_num);
 575   if (status != 0)
 576     return status;
 577
 578   if (global_cpu_num <= cpu_num)
 579     global_cpu_num = cpu_num + 1;
 580
 581   s = get_cpu_state(cpu_num, state);
 582
 583   status = value_to_rate(&rate, val, DS_TYPE_DERIVE, now, &s->conv);
 584   if (status != 0)
 585     return status;
 586
 587   s->rate = rate;
 588   s->has_value = 1;
 589   return 0;
 590 } /* }}} int cpu_stage */
 591
 592 static int cpu_read(void) {
 593   cdtime_t now = cdtime();
 594
 595 #if PROCESSOR_CPU_LOAD_INFO /* {{{ */
 596   kern_return_t status;
 597
 598   processor_cpu_load_info_data_t cpu_info;
 599   mach_msg_type_number_t cpu_info_len;
 600
 601   host_t cpu_host;
 602
 603   for (mach_msg_type_number_t cpu = 0; cpu < cpu_list_len; cpu++) {
 604     cpu_host = 0;
 605     cpu_info_len = PROCESSOR_BASIC_INFO_COUNT;
 606
 607     status = processor_info(cpu_list[cpu], PROCESSOR_CPU_LOAD_INFO, &cpu_host,
 608                             (processor_info_t)&cpu_info, &cpu_info_len);
 609     if (status != KERN_SUCCESS) {
 610       ERROR("cpu plugin: processor_info (PROCESSOR_CPU_LOAD_INFO) failed: %s",
 611             mach_error_string(status));
 612       continue;
 613     }
 614
 615     if (cpu_info_len < CPU_STATE_MAX) {
 616       ERROR("cpu plugin: processor_info returned only %i elements..",
 617             cpu_info_len);
 618       continue;
 619     }
 620
 621     cpu_stage(cpu, COLLECTD_CPU_STATE_USER,
 622               (derive_t)cpu_info.cpu_ticks[CPU_STATE_USER], now);
 623     cpu_stage(cpu, COLLECTD_CPU_STATE_NICE,
 624               (derive_t)cpu_info.cpu_ticks[CPU_STATE_NICE], now);
 625     cpu_stage(cpu, COLLECTD_CPU_STATE_SYSTEM,
 626               (derive_t)cpu_info.cpu_ticks[CPU_STATE_SYSTEM], now);
 627     cpu_stage(cpu, COLLECTD_CPU_STATE_IDLE,
 628               (derive_t)cpu_info.cpu_ticks[CPU_STATE_IDLE], now);
 629   }
 630 /* }}} #endif PROCESSOR_CPU_LOAD_INFO */
 631
 632 #elif defined(KERNEL_LINUX) /* {{{ */
 633   int cpu;
 634   FILE *fh;
 635   char buf[1024];
 636
 637   char *fields[11];
 638   int numfields;
 639
 640   if ((fh = fopen("/proc/stat", "r")) == NULL) {
 641     ERROR("cpu plugin: fopen (/proc/stat) failed: %s", STRERRNO);
 642     return -1;
 643   }
 644
 645   while (fgets(buf, 1024, fh) != NULL) {
 646     if (strncmp(buf, "cpu", 3))
 647       continue;
 648     if ((buf[3] < '0') || (buf[3] > '9'))
 649       continue;
 650
 651     numfields = strsplit(buf, fields, STATIC_ARRAY_SIZE(fields));
 652     if (numfields < 5)
 653       continue;
 654
 655     cpu = atoi(fields[0] + 3);
 656
 657     /* Do not stage User and Nice immediately: we may need to alter them later:
 658      */
 659     long long user_value = atoll(fields[1]);
 660     long long nice_value = atoll(fields[2]);
 661     cpu_stage(cpu, COLLECTD_CPU_STATE_SYSTEM, (derive_t)atoll(fields[3]), now);
 662     cpu_stage(cpu, COLLECTD_CPU_STATE_IDLE, (derive_t)atoll(fields[4]), now);
 663
 664     if (numfields >= 8) {
 665       cpu_stage(cpu, COLLECTD_CPU_STATE_WAIT, (derive_t)atoll(fields[5]), now);
 666       cpu_stage(cpu, COLLECTD_CPU_STATE_INTERRUPT, (derive_t)atoll(fields[6]),
 667                 now);
 668       cpu_stage(cpu, COLLECTD_CPU_STATE_SOFTIRQ, (derive_t)atoll(fields[7]),
 669                 now);
 670     }
 671
 672     if (numfields >= 9) { /* Steal (since Linux 2.6.11) */
 673       cpu_stage(cpu, COLLECTD_CPU_STATE_STEAL, (derive_t)atoll(fields[8]), now);
 674     }
 675
 676     if (numfields >= 10) { /* Guest (since Linux 2.6.24) */
 677       if (report_guest) {
 678         long long value = atoll(fields[9]);
 679         cpu_stage(cpu, COLLECTD_CPU_STATE_GUEST, (derive_t)value, now);
 680         /* Guest is included in User; optionally subtract Guest from User: */
 681         if (subtract_guest) {
 682           user_value -= value;
 683           if (user_value < 0)
 684             user_value = 0;
 685         }
 686       }
 687     }
 688
 689     if (numfields >= 11) { /* Guest_nice (since Linux 2.6.33) */
 690       if (report_guest) {
 691         long long value = atoll(fields[10]);
 692         cpu_stage(cpu, COLLECTD_CPU_STATE_GUEST_NICE, (derive_t)value, now);
 693         /* Guest_nice is included in Nice; optionally subtract Guest_nice from
 694            Nice: */
 695         if (subtract_guest) {
 696           nice_value -= value;
 697           if (nice_value < 0)
 698             nice_value = 0;
 699         }
 700       }
 701     }
 702
 703     /* Eventually stage User and Nice: */
 704     cpu_stage(cpu, COLLECTD_CPU_STATE_USER, (derive_t)user_value, now);
 705     cpu_stage(cpu, COLLECTD_CPU_STATE_NICE, (derive_t)nice_value, now);
 706   }
 707   fclose(fh);
 708 /* }}} #endif defined(KERNEL_LINUX) */
 709
 710 #elif defined(HAVE_LIBKSTAT) /* {{{ */
 711   static cpu_stat_t cs;
 712
 713   if (kc == NULL)
 714     return -1;
 715
 716   for (int cpu = 0; cpu < numcpu; cpu++) {
 717     if (kstat_read(kc, ksp[cpu], &cs) == -1)
 718       continue; /* error message? */
 719
 720     cpu_stage(ksp[cpu]->ks_instance, COLLECTD_CPU_STATE_IDLE,
 721               (derive_t)cs.cpu_sysinfo.cpu[CPU_IDLE], now);
 722     cpu_stage(ksp[cpu]->ks_instance, COLLECTD_CPU_STATE_USER,
 723               (derive_t)cs.cpu_sysinfo.cpu[CPU_USER], now);
 724     cpu_stage(ksp[cpu]->ks_instance, COLLECTD_CPU_STATE_SYSTEM,
 725               (derive_t)cs.cpu_sysinfo.cpu[CPU_KERNEL], now);
 726     cpu_stage(ksp[cpu]->ks_instance, COLLECTD_CPU_STATE_WAIT,
 727               (derive_t)cs.cpu_sysinfo.cpu[CPU_WAIT], now);
 728   }
 729 /* }}} #endif defined(HAVE_LIBKSTAT) */
 730
 731 #elif CAN_USE_SYSCTL /* {{{ */
 732   uint64_t cpuinfo[numcpu][CPUSTATES];
 733   size_t cpuinfo_size;
 734   int status;
 735
 736   if (numcpu < 1) {
 737     ERROR("cpu plugin: Could not determine number of "
 738           "installed CPUs using sysctl(3).");
 739     return -1;
 740   }
 741
 742   memset(cpuinfo, 0, sizeof(cpuinfo));
 743
 744 #if defined(KERN_CPTIME2)
 745   if (numcpu > 1) {
 746     for (int i = 0; i < numcpu; i++) {
 747       int mib[] = {CTL_KERN, KERN_CPTIME2, i};
 748
 749       cpuinfo_size = sizeof(cpuinfo[0]);
 750
 751       status = sysctl(mib, STATIC_ARRAY_SIZE(mib), cpuinfo[i], &cpuinfo_size,
 752                       NULL, 0);
 753       if (status == -1) {
 754         ERROR("cpu plugin: sysctl failed: %s.", STRERRNO);
 755         return -1;
 756       }
 757     }
 758   } else
 759 #endif /* defined(KERN_CPTIME2) */
 760   {
 761     int mib[] = {CTL_KERN, KERN_CPTIME};
 762     long cpuinfo_tmp[CPUSTATES];
 763
 764     cpuinfo_size = sizeof(cpuinfo_tmp);
 765
 766     status = sysctl(mib, STATIC_ARRAY_SIZE(mib), &cpuinfo_tmp, &cpuinfo_size,
 767                     NULL, 0);
 768     if (status == -1) {
 769       ERROR("cpu plugin: sysctl failed: %s.", STRERRNO);
 770       return -1;
 771     }
 772
 773     for (int i = 0; i < CPUSTATES; i++) {
 774       cpuinfo[0][i] = cpuinfo_tmp[i];
 775     }
 776   }
 777
 778   for (int i = 0; i < numcpu; i++) {
 779     cpu_stage(i, COLLECTD_CPU_STATE_USER, (derive_t)cpuinfo[i][CP_USER], now);
 780     cpu_stage(i, COLLECTD_CPU_STATE_NICE, (derive_t)cpuinfo[i][CP_NICE], now);
 781     cpu_stage(i, COLLECTD_CPU_STATE_SYSTEM, (derive_t)cpuinfo[i][CP_SYS], now);
 782     cpu_stage(i, COLLECTD_CPU_STATE_IDLE, (derive_t)cpuinfo[i][CP_IDLE], now);
 783     cpu_stage(i, COLLECTD_CPU_STATE_INTERRUPT, (derive_t)cpuinfo[i][CP_INTR],
 784               now);
 785   }
 786 /* }}} #endif CAN_USE_SYSCTL */
 787
 788 #elif defined(HAVE_SYSCTLBYNAME) && defined(HAVE_SYSCTL_KERN_CP_TIMES) /* {{{  \
 789                                                                           */
 790   long cpuinfo[maxcpu][CPUSTATES];
 791   size_t cpuinfo_size;
 792
 793   memset(cpuinfo, 0, sizeof(cpuinfo));
 794
 795   cpuinfo_size = sizeof(cpuinfo);
 796   if (sysctlbyname("kern.cp_times", &cpuinfo, &cpuinfo_size, NULL, 0) < 0) {
 797     ERROR("cpu plugin: sysctlbyname failed: %s.", STRERRNO);
 798     return -1;
 799   }
 800
 801   for (int i = 0; i < numcpu; i++) {
 802     cpu_stage(i, COLLECTD_CPU_STATE_USER, (derive_t)cpuinfo[i][CP_USER], now);
 803     cpu_stage(i, COLLECTD_CPU_STATE_NICE, (derive_t)cpuinfo[i][CP_NICE], now);
 804     cpu_stage(i, COLLECTD_CPU_STATE_SYSTEM, (derive_t)cpuinfo[i][CP_SYS], now);
 805     cpu_stage(i, COLLECTD_CPU_STATE_IDLE, (derive_t)cpuinfo[i][CP_IDLE], now);
 806     cpu_stage(i, COLLECTD_CPU_STATE_INTERRUPT, (derive_t)cpuinfo[i][CP_INTR],
 807               now);
 808   }
 809 /* }}} #endif HAVE_SYSCTL_KERN_CP_TIMES */
 810
 811 #elif defined(HAVE_SYSCTLBYNAME) /* {{{ */
 812   long cpuinfo[CPUSTATES];
 813   size_t cpuinfo_size;
 814
 815   cpuinfo_size = sizeof(cpuinfo);
 816
 817   if (sysctlbyname("kern.cp_time", &cpuinfo, &cpuinfo_size, NULL, 0) < 0) {
 818     ERROR("cpu plugin: sysctlbyname failed: %s.", STRERRNO);
 819     return -1;
 820   }
 821
 822   cpu_stage(0, COLLECTD_CPU_STATE_USER, (derive_t)cpuinfo[CP_USER], now);
 823   cpu_stage(0, COLLECTD_CPU_STATE_NICE, (derive_t)cpuinfo[CP_NICE], now);
 824   cpu_stage(0, COLLECTD_CPU_STATE_SYSTEM, (derive_t)cpuinfo[CP_SYS], now);
 825   cpu_stage(0, COLLECTD_CPU_STATE_IDLE, (derive_t)cpuinfo[CP_IDLE], now);
 826   cpu_stage(0, COLLECTD_CPU_STATE_INTERRUPT, (derive_t)cpuinfo[CP_INTR], now);
 827 /* }}} #endif HAVE_SYSCTLBYNAME */
 828
 829 #elif defined(HAVE_LIBSTATGRAB) /* {{{ */
 830   sg_cpu_stats *cs;
 831   cs = sg_get_cpu_stats();
 832
 833   if (cs == NULL) {
 834     ERROR("cpu plugin: sg_get_cpu_stats failed.");
 835     return -1;
 836   }
 837
 838   cpu_state(0, COLLECTD_CPU_STATE_IDLE, (derive_t)cs->idle);
 839   cpu_state(0, COLLECTD_CPU_STATE_NICE, (derive_t)cs->nice);
 840   cpu_state(0, COLLECTD_CPU_STATE_SWAP, (derive_t)cs->swap);
 841   cpu_state(0, COLLECTD_CPU_STATE_SYSTEM, (derive_t)cs->kernel);
 842   cpu_state(0, COLLECTD_CPU_STATE_USER, (derive_t)cs->user);
 843   cpu_state(0, COLLECTD_CPU_STATE_WAIT, (derive_t)cs->iowait);
 844 /* }}} #endif HAVE_LIBSTATGRAB */
 845
 846 #elif defined(HAVE_PERFSTAT) /* {{{ */
 847   perfstat_id_t id;
 848   int cpus;
 849
 850   numcpu = perfstat_cpu(NULL, NULL, sizeof(perfstat_cpu_t), 0);
 851   if (numcpu == -1) {
 852     WARNING("cpu plugin: perfstat_cpu: %s", STRERRNO);
 853     return -1;
 854   }
 855
 856   if (pnumcpu != numcpu || perfcpu == NULL) {
 857     free(perfcpu);
 858     perfcpu = malloc(numcpu * sizeof(perfstat_cpu_t));
 859   }
 860   pnumcpu = numcpu;
 861
 862   id.name[0] = '\0';
 863   if ((cpus = perfstat_cpu(&id, perfcpu, sizeof(perfstat_cpu_t), numcpu)) < 0) {
 864     WARNING("cpu plugin: perfstat_cpu: %s", STRERRNO);
 865     return -1;
 866   }
 867
 868   for (int i = 0; i < cpus; i++) {
 869     cpu_stage(i, COLLECTD_CPU_STATE_IDLE, (derive_t)perfcpu[i].idle, now);
 870     cpu_stage(i, COLLECTD_CPU_STATE_SYSTEM, (derive_t)perfcpu[i].sys, now);
 871     cpu_stage(i, COLLECTD_CPU_STATE_USER, (derive_t)perfcpu[i].user, now);
 872     cpu_stage(i, COLLECTD_CPU_STATE_WAIT, (derive_t)perfcpu[i].wait, now);
 873   }
 874 #endif                       /* }}} HAVE_PERFSTAT */
 875
 876   cpu_commit();
 877   cpu_reset();
 878   return 0;
 879 }
 880
 881 void module_register(void) {
 882   plugin_register_init("cpu", init);
 883   plugin_register_config("cpu", cpu_config, config_keys, config_keys_num);
 884   plugin_register_read("cpu", cpu_read);
 885 } /* void module_register */