2 * turbostat -- Log CPU frequency and C-state residency
3 * on modern Intel turbo-capable processors for collectd.
5 * Based on the 'turbostat' tool of the Linux kernel, found at
6 * linux/tools/power/x86/turbostat/turbostat.c:
8 * Copyright (c) 2013 Intel Corporation.
9 * Len Brown <len.brown@intel.com>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms and conditions of the GNU General Public License,
13 * version 2, as published by the Free Software Foundation.
15 * This program is distributed in the hope it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
24 * Ported to collectd by Vincent Brillault <git@lerya.net>
28 * _GNU_SOURCE is required because of the following functions:
42 #include "utils_time.h"
44 #include "msr-index.h"
46 #ifdef HAVE_SYS_CAPABILITY_H
47 #include <sys/capability.h>
48 #endif /* HAVE_SYS_CAPABILITY_H */
50 #define PLUGIN_NAME "turbostat"
53 * This tool uses the Model-Specific Registers (MSRs) present on Intel
55 * The general description each of these registers, depending on the
57 * can be found in the IntelĀ® 64 and IA-32 Architectures Software Developer
59 * Volume 3 Chapter 35.
63 * If set, aperf_mperf_unstable disables a/mperf based stats.
64 * This includes: C0 & C1 states, frequency
66 * This value is automatically set if mperf or aperf go backward
68 static _Bool aperf_mperf_unstable;
71 * If set, use kernel logical core numbering for all "per core" metrics.
73 static _Bool config_lcn;
76 * Bitmask of the list of core C states supported by the processor.
77 * Currently supported C-states (by this plugin): 3, 6, 7
79 static unsigned int do_core_cstate;
80 static unsigned int config_core_cstate;
81 static _Bool apply_config_core_cstate;
84 * Bitmask of the list of pacages C states supported by the processor.
85 * Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
87 static unsigned int do_pkg_cstate;
88 static unsigned int config_pkg_cstate;
89 static _Bool apply_config_pkg_cstate;
92 * Boolean indicating if the processor supports 'I/O System-Management Interrupt
96 static _Bool config_smi;
97 static _Bool apply_config_smi;
100 * Boolean indicating if the processor supports 'Digital temperature sensor'
101 * This feature enables the monitoring of the temperature of each core
103 * This feature has two limitations:
104 * - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature
106 * - Temperatures above the tcc_activation_temp are not recorded
109 static _Bool config_dts;
110 static _Bool apply_config_dts;
113 * Boolean indicating if the processor supports 'Package thermal management'
114 * This feature allows the monitoring of the temperature of each package
116 * This feature has two limitations:
117 * - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature
119 * - Temperatures above the tcc_activation_temp are not recorded
122 static _Bool config_ptm;
123 static _Bool apply_config_ptm;
126 * Thermal Control Circuit Activation Temperature as configured by the user.
127 * This override the automated detection via MSR_IA32_TEMPERATURE_TARGET
128 * and should only be used if the automated detection fails.
130 static unsigned int tcc_activation_temp;
132 static unsigned int do_rapl;
133 static unsigned int config_rapl;
134 static _Bool apply_config_rapl;
135 static double rapl_energy_units;
137 #define RAPL_PKG (1 << 0)
138 /* 0x610 MSR_PKG_POWER_LIMIT */
139 /* 0x611 MSR_PKG_ENERGY_STATUS */
140 #define RAPL_DRAM (1 << 1)
141 /* 0x618 MSR_DRAM_POWER_LIMIT */
142 /* 0x619 MSR_DRAM_ENERGY_STATUS */
143 /* 0x61c MSR_DRAM_POWER_INFO */
144 #define RAPL_CORES (1 << 2)
145 /* 0x638 MSR_PP0_POWER_LIMIT */
146 /* 0x639 MSR_PP0_ENERGY_STATUS */
148 #define RAPL_GFX (1 << 3)
149 /* 0x640 MSR_PP1_POWER_LIMIT */
150 /* 0x641 MSR_PP1_ENERGY_STATUS */
151 /* 0x642 MSR_PP1_POLICY */
152 #define TJMAX_DEFAULT 100
154 static cpu_set_t *cpu_present_set, *cpu_affinity_set, *cpu_saved_affinity_set;
155 static size_t cpu_present_setsize, cpu_affinity_setsize,
156 cpu_saved_affinity_setsize;
158 static struct thread_data {
159 unsigned long long tsc;
160 unsigned long long aperf;
161 unsigned long long mperf;
162 unsigned long long c1;
163 unsigned int smi_count;
166 #define CPU_IS_FIRST_THREAD_IN_CORE 0x2
167 #define CPU_IS_FIRST_CORE_IN_PACKAGE 0x4
168 } * thread_delta, *thread_even, *thread_odd;
170 static struct core_data {
171 unsigned long long c3;
172 unsigned long long c6;
173 unsigned long long c7;
174 unsigned int core_temp_c;
175 unsigned int core_id;
176 } * core_delta, *core_even, *core_odd;
178 static struct pkg_data {
179 unsigned long long pc2;
180 unsigned long long pc3;
181 unsigned long long pc6;
182 unsigned long long pc7;
183 unsigned long long pc8;
184 unsigned long long pc9;
185 unsigned long long pc10;
186 unsigned int package_id;
187 uint32_t energy_pkg; /* MSR_PKG_ENERGY_STATUS */
188 uint32_t energy_dram; /* MSR_DRAM_ENERGY_STATUS */
189 uint32_t energy_cores; /* MSR_PP0_ENERGY_STATUS */
190 uint32_t energy_gfx; /* MSR_PP1_ENERGY_STATUS */
191 unsigned int tcc_activation_temp;
192 unsigned int pkg_temp_c;
193 } * package_delta, *package_even, *package_odd;
195 #define DELTA_COUNTERS thread_delta, core_delta, package_delta
196 #define ODD_COUNTERS thread_odd, core_odd, package_odd
197 #define EVEN_COUNTERS thread_even, core_even, package_even
198 static _Bool is_even = 1;
200 static _Bool allocated = 0;
201 static _Bool initialized = 0;
203 #define GET_THREAD(thread_base, thread_no, core_no, pkg_no) \
204 (thread_base + (pkg_no)*topology.num_cores * topology.num_threads + \
205 (core_no)*topology.num_threads + (thread_no))
206 #define GET_CORE(core_base, core_no, pkg_no) \
207 (core_base + (pkg_no)*topology.num_cores + (core_no))
208 #define GET_PKG(pkg_base, pkg_no) (pkg_base + pkg_no)
210 struct cpu_topology {
211 unsigned int package_id;
212 unsigned int core_id;
213 _Bool first_core_in_package;
214 _Bool first_thread_in_core;
217 static struct topology {
218 unsigned int max_cpu_id;
219 unsigned int num_packages;
220 unsigned int num_cores;
221 unsigned int num_threads;
222 struct cpu_topology *cpus;
225 static cdtime_t time_even, time_odd, time_delta;
227 static const char *config_keys[] = {
230 "SystemManagementInterrupt",
231 "DigitalTemperatureSensor",
232 "PackageThermalManagement",
234 "RunningAveragePowerLimit",
237 static const int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
239 /*****************************
240 * MSR Manipulation helpers *
241 *****************************/
244 * Open a MSR device for reading
245 * Can change the scheduling affinity of the current process if multiple_read is
248 static int __attribute__((warn_unused_result))
249 open_msr(unsigned int cpu, _Bool multiple_read) {
254 * If we need to do multiple read, let's migrate to the CPU
255 * Otherwise, we would lose time calling functions on another CPU
257 * If we are not yet initialized (cpu_affinity_setsize = 0),
258 * we need to skip this optimisation.
260 if (multiple_read && cpu_affinity_setsize) {
261 CPU_ZERO_S(cpu_affinity_setsize, cpu_affinity_set);
262 CPU_SET_S(cpu, cpu_affinity_setsize, cpu_affinity_set);
263 if (sched_setaffinity(0, cpu_affinity_setsize, cpu_affinity_set) == -1) {
264 ERROR("turbostat plugin: Could not migrate to CPU %d", cpu);
269 snprintf(pathname, sizeof(pathname), "/dev/cpu/%d/msr", cpu);
270 fd = open(pathname, O_RDONLY);
272 ERROR("turbostat plugin: failed to open %s", pathname);
279 * Read a single MSR from an open file descriptor
281 static int __attribute__((warn_unused_result))
282 read_msr(int fd, off_t offset, unsigned long long *msr) {
285 retval = pread(fd, msr, sizeof *msr, offset);
287 if (retval != sizeof *msr) {
288 ERROR("turbostat plugin: MSR offset 0x%llx read failed",
289 (unsigned long long)offset);
296 * Open a MSR device for reading, read the value asked for and close it.
297 * This call will not affect the scheduling affinity of this thread.
299 static ssize_t __attribute__((warn_unused_result))
300 get_msr(unsigned int cpu, off_t offset, unsigned long long *msr) {
304 fd = open_msr(cpu, 0);
307 retval = read_msr(fd, offset, msr);
312 /********************************
313 * Raw data acquisition (1 CPU) *
314 ********************************/
317 * Read every data avalaible for a single CPU
319 * Core data is shared for all threads in one core: extracted only for the first
321 * Package data is shared for all core in one package: extracted only for the
322 * first thread of the first core
324 * Side effect: migrates to the targeted CPU
326 static int __attribute__((warn_unused_result))
327 get_counters(struct thread_data *t, struct core_data *c, struct pkg_data *p) {
328 unsigned int cpu = t->cpu_id;
329 unsigned long long msr;
333 msr_fd = open_msr(cpu, 1);
337 #define READ_MSR(msr, dst) \
339 if (read_msr(msr_fd, msr, dst)) { \
340 ERROR("turbostat plugin: Unable to read " #msr); \
346 READ_MSR(MSR_IA32_TSC, &t->tsc);
348 READ_MSR(MSR_IA32_APERF, &t->aperf);
349 READ_MSR(MSR_IA32_MPERF, &t->mperf);
352 READ_MSR(MSR_SMI_COUNT, &msr);
353 t->smi_count = msr & 0xFFFFFFFF;
356 /* collect core counters only for 1st thread in core */
357 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE)) {
362 if (do_core_cstate & (1 << 3))
363 READ_MSR(MSR_CORE_C3_RESIDENCY, &c->c3);
364 if (do_core_cstate & (1 << 6))
365 READ_MSR(MSR_CORE_C6_RESIDENCY, &c->c6);
366 if (do_core_cstate & (1 << 7))
367 READ_MSR(MSR_CORE_C7_RESIDENCY, &c->c7);
370 READ_MSR(MSR_IA32_THERM_STATUS, &msr);
371 c->core_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
374 /* collect package counters only for 1st core in package */
375 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)) {
380 if (do_pkg_cstate & (1 << 2))
381 READ_MSR(MSR_PKG_C2_RESIDENCY, &p->pc2);
382 if (do_pkg_cstate & (1 << 3))
383 READ_MSR(MSR_PKG_C3_RESIDENCY, &p->pc3);
384 if (do_pkg_cstate & (1 << 6))
385 READ_MSR(MSR_PKG_C6_RESIDENCY, &p->pc6);
386 if (do_pkg_cstate & (1 << 7))
387 READ_MSR(MSR_PKG_C7_RESIDENCY, &p->pc7);
388 if (do_pkg_cstate & (1 << 8))
389 READ_MSR(MSR_PKG_C8_RESIDENCY, &p->pc8);
390 if (do_pkg_cstate & (1 << 9))
391 READ_MSR(MSR_PKG_C9_RESIDENCY, &p->pc9);
392 if (do_pkg_cstate & (1 << 10))
393 READ_MSR(MSR_PKG_C10_RESIDENCY, &p->pc10);
395 if (do_rapl & RAPL_PKG) {
396 READ_MSR(MSR_PKG_ENERGY_STATUS, &msr);
397 p->energy_pkg = msr & 0xFFFFFFFF;
399 if (do_rapl & RAPL_CORES) {
400 READ_MSR(MSR_PP0_ENERGY_STATUS, &msr);
401 p->energy_cores = msr & 0xFFFFFFFF;
403 if (do_rapl & RAPL_DRAM) {
404 READ_MSR(MSR_DRAM_ENERGY_STATUS, &msr);
405 p->energy_dram = msr & 0xFFFFFFFF;
407 if (do_rapl & RAPL_GFX) {
408 READ_MSR(MSR_PP1_ENERGY_STATUS, &msr);
409 p->energy_gfx = msr & 0xFFFFFFFF;
412 READ_MSR(MSR_IA32_PACKAGE_THERM_STATUS, &msr);
413 p->pkg_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
421 /**********************************
422 * Evaluating the changes (1 CPU) *
423 **********************************/
426 * Extract the evolution old->new in delta at a package level
427 * (some are not new-delta, e.g. temperature)
429 static inline void delta_package(struct pkg_data *delta,
430 const struct pkg_data *new,
431 const struct pkg_data *old) {
432 delta->pc2 = new->pc2 - old->pc2;
433 delta->pc3 = new->pc3 - old->pc3;
434 delta->pc6 = new->pc6 - old->pc6;
435 delta->pc7 = new->pc7 - old->pc7;
436 delta->pc8 = new->pc8 - old->pc8;
437 delta->pc9 = new->pc9 - old->pc9;
438 delta->pc10 = new->pc10 - old->pc10;
439 delta->pkg_temp_c = new->pkg_temp_c;
441 delta->energy_pkg = new->energy_pkg - old->energy_pkg;
442 delta->energy_cores = new->energy_cores - old->energy_cores;
443 delta->energy_gfx = new->energy_gfx - old->energy_gfx;
444 delta->energy_dram = new->energy_dram - old->energy_dram;
448 * Extract the evolution old->new in delta at a core level
449 * (some are not new-delta, e.g. temperature)
451 static inline void delta_core(struct core_data *delta,
452 const struct core_data *new,
453 const struct core_data *old) {
454 delta->c3 = new->c3 - old->c3;
455 delta->c6 = new->c6 - old->c6;
456 delta->c7 = new->c7 - old->c7;
457 delta->core_temp_c = new->core_temp_c;
461 * Extract the evolution old->new in delta at a package level
462 * core_delta is required for c1 estimation (tsc - c0 - all core cstates)
464 static inline int __attribute__((warn_unused_result))
465 delta_thread(struct thread_data *delta, const struct thread_data *new,
466 const struct thread_data *old, const struct core_data *cdelta) {
467 delta->tsc = new->tsc - old->tsc;
469 /* check for TSC < 1 Mcycles over interval */
470 if (delta->tsc < (1000 * 1000)) {
471 WARNING("turbostat plugin: Insanely slow TSC rate, TSC stops "
472 "in idle? You can disable all c-states by booting with"
473 " 'idle=poll' or just the deep ones with"
474 " 'processor.max_cstate=1'");
478 delta->c1 = new->c1 - old->c1;
480 if ((new->aperf > old->aperf) && (new->mperf > old->mperf)) {
481 delta->aperf = new->aperf - old->aperf;
482 delta->mperf = new->mperf - old->mperf;
484 if (!aperf_mperf_unstable) {
485 WARNING("turbostat plugin: APERF or MPERF went "
486 "backwards. Frequency results do not cover "
487 "the entire interval. Fix this by running "
488 "Linux-2.6.30 or later.");
490 aperf_mperf_unstable = 1;
495 * As counter collection is not atomic,
496 * it is possible for mperf's non-halted cycles + idle states
497 * to exceed TSC's all cycles: show c1 = 0% in that case.
499 if ((delta->mperf + cdelta->c3 + cdelta->c6 + cdelta->c7) > delta->tsc)
502 /* normal case, derive c1 */
504 delta->tsc - delta->mperf - cdelta->c3 - cdelta->c6 - cdelta->c7;
507 if (delta->mperf == 0) {
508 WARNING("turbostat plugin: cpu%d MPERF 0!", old->cpu_id);
509 delta->mperf = 1; /* divide by 0 protection */
513 delta->smi_count = new->smi_count - old->smi_count;
518 /**********************************
519 * Submitting the results (1 CPU) *
520 **********************************/
523 * Submit one gauge value
525 static void turbostat_submit(const char *plugin_instance, const char *type,
526 const char *type_instance, gauge_t value) {
527 value_list_t vl = VALUE_LIST_INIT;
529 vl.values = &(value_t){.gauge = value};
531 sstrncpy(vl.plugin, PLUGIN_NAME, sizeof(vl.plugin));
532 if (plugin_instance != NULL)
533 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
534 sstrncpy(vl.type, type, sizeof(vl.type));
535 if (type_instance != NULL)
536 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
538 plugin_dispatch_values(&vl);
542 * Submit every data for a single CPU
544 * Core data is shared for all threads in one core: submitted only for the first
546 * Package data is shared for all core in one package: submitted only for the
547 * first thread of the first core
549 static int submit_counters(struct thread_data *t, struct core_data *c,
550 struct pkg_data *p) {
551 char name[DATA_MAX_NAME_LEN];
552 double interval_float;
554 interval_float = CDTIME_T_TO_DOUBLE(time_delta);
556 DEBUG("turbostat plugin: submit stats for cpu: %d, core: %d, pkg: %d",
557 t->cpu_id, c->core_id, p->package_id);
559 snprintf(name, sizeof(name), "cpu%02d", t->cpu_id);
561 if (!aperf_mperf_unstable)
562 turbostat_submit(name, "percent", "c0", 100.0 * t->mperf / t->tsc);
563 if (!aperf_mperf_unstable)
564 turbostat_submit(name, "percent", "c1", 100.0 * t->c1 / t->tsc);
566 turbostat_submit(name, "frequency", "average",
567 1.0 / 1000000 * t->aperf / interval_float);
569 if ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc)))
570 turbostat_submit(name, "frequency", "busy",
571 1.0 * t->tsc / 1000000 * t->aperf / t->mperf /
574 /* Sanity check (should stay stable) */
575 turbostat_submit(name, "gauge", "TSC",
576 1.0 * t->tsc / 1000000 / interval_float);
580 turbostat_submit(name, "count", NULL, t->smi_count);
582 /* submit per-core data only for 1st thread in core */
583 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
586 /* If not using logical core numbering, set core id */
588 if (topology.num_packages > 1)
589 snprintf(name, sizeof(name), "pkg%02d-core%02d", p->package_id,
592 snprintf(name, sizeof(name), "core%02d", c->core_id);
595 if (do_core_cstate & (1 << 3))
596 turbostat_submit(name, "percent", "c3", 100.0 * c->c3 / t->tsc);
597 if (do_core_cstate & (1 << 6))
598 turbostat_submit(name, "percent", "c6", 100.0 * c->c6 / t->tsc);
599 if (do_core_cstate & (1 << 7))
600 turbostat_submit(name, "percent", "c7", 100.0 * c->c7 / t->tsc);
603 turbostat_submit(name, "temperature", NULL, c->core_temp_c);
605 /* submit per-package data only for 1st core in package */
606 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
609 snprintf(name, sizeof(name), "pkg%02d", p->package_id);
612 turbostat_submit(name, "temperature", NULL, p->pkg_temp_c);
614 if (do_pkg_cstate & (1 << 2))
615 turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2 / t->tsc);
616 if (do_pkg_cstate & (1 << 3))
617 turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3 / t->tsc);
618 if (do_pkg_cstate & (1 << 6))
619 turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6 / t->tsc);
620 if (do_pkg_cstate & (1 << 7))
621 turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7 / t->tsc);
622 if (do_pkg_cstate & (1 << 8))
623 turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8 / t->tsc);
624 if (do_pkg_cstate & (1 << 9))
625 turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9 / t->tsc);
626 if (do_pkg_cstate & (1 << 10))
627 turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10 / t->tsc);
630 if (do_rapl & RAPL_PKG)
631 turbostat_submit(name, "power", "pkg",
632 p->energy_pkg * rapl_energy_units / interval_float);
633 if (do_rapl & RAPL_CORES)
634 turbostat_submit(name, "power", "cores",
635 p->energy_cores * rapl_energy_units / interval_float);
636 if (do_rapl & RAPL_GFX)
637 turbostat_submit(name, "power", "GFX",
638 p->energy_gfx * rapl_energy_units / interval_float);
639 if (do_rapl & RAPL_DRAM)
640 turbostat_submit(name, "power", "DRAM",
641 p->energy_dram * rapl_energy_units / interval_float);
647 /**********************************
648 * Looping function over all CPUs *
649 **********************************/
652 * Check if a given cpu id is in our compiled list of existing CPUs
654 static int cpu_is_not_present(unsigned int cpu) {
655 return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
659 * Loop on all CPUs in topological order
661 * Skip non-present cpus
662 * Return the error code at the first error or 0
664 static int __attribute__((warn_unused_result))
665 for_all_cpus(int(func)(struct thread_data *, struct core_data *,
667 struct thread_data *thread_base, struct core_data *core_base,
668 struct pkg_data *pkg_base) {
671 for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
672 for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
673 for (unsigned int thread_no = 0; thread_no < topology.num_threads;
675 struct thread_data *t;
679 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
681 if (cpu_is_not_present(t->cpu_id))
684 c = GET_CORE(core_base, core_no, pkg_no);
685 p = GET_PKG(pkg_base, pkg_no);
687 retval = func(t, c, p);
697 * Dedicated loop: Extract every data evolution for all CPU
699 * Skip non-present cpus
700 * Return the error code at the first error or 0
702 * Core data is shared for all threads in one core: extracted only for the first
704 * Package data is shared for all core in one package: extracted only for the
705 * first thread of the first core
707 static int __attribute__((warn_unused_result))
708 for_all_cpus_delta(const struct thread_data *thread_new_base,
709 const struct core_data *core_new_base,
710 const struct pkg_data *pkg_new_base,
711 const struct thread_data *thread_old_base,
712 const struct core_data *core_old_base,
713 const struct pkg_data *pkg_old_base) {
716 for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
717 for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
718 for (unsigned int thread_no = 0; thread_no < topology.num_threads;
720 struct thread_data *t_delta;
721 const struct thread_data *t_old, *t_new;
722 struct core_data *c_delta;
724 /* Get correct pointers for threads */
725 t_delta = GET_THREAD(thread_delta, thread_no, core_no, pkg_no);
726 t_new = GET_THREAD(thread_new_base, thread_no, core_no, pkg_no);
727 t_old = GET_THREAD(thread_old_base, thread_no, core_no, pkg_no);
729 /* Skip threads that disappeared */
730 if (cpu_is_not_present(t_delta->cpu_id))
733 /* c_delta is always required for delta_thread */
734 c_delta = GET_CORE(core_delta, core_no, pkg_no);
736 /* calculate core delta only for 1st thread in core */
737 if (t_new->flags & CPU_IS_FIRST_THREAD_IN_CORE) {
738 const struct core_data *c_old, *c_new;
740 c_new = GET_CORE(core_new_base, core_no, pkg_no);
741 c_old = GET_CORE(core_old_base, core_no, pkg_no);
743 delta_core(c_delta, c_new, c_old);
746 /* Always calculate thread delta */
747 retval = delta_thread(t_delta, t_new, t_old, c_delta);
751 /* calculate package delta only for 1st core in package */
752 if (t_new->flags & CPU_IS_FIRST_CORE_IN_PACKAGE) {
753 struct pkg_data *p_delta;
754 const struct pkg_data *p_old, *p_new;
756 p_delta = GET_PKG(package_delta, pkg_no);
757 p_new = GET_PKG(pkg_new_base, pkg_no);
758 p_old = GET_PKG(pkg_old_base, pkg_no);
760 delta_package(p_delta, p_new, p_old);
773 * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
774 * the Thermal Control Circuit (TCC) activates.
775 * This is usually equal to tjMax.
777 * Older processors do not have this MSR, so there we guess,
778 * but also allow conficuration over-ride with "TCCActivationTemp".
780 * Several MSR temperature values are in units of degrees-C
781 * below this value, including the Digital Thermal Sensor (DTS),
782 * Package Thermal Management Sensor (PTM), and thermal event thresholds.
784 static int __attribute__((warn_unused_result))
785 set_temperature_target(struct thread_data *t, struct core_data *c,
786 struct pkg_data *p) {
787 unsigned long long msr;
788 unsigned int target_c_local;
790 /* tcc_activation_temp is used only for dts or ptm */
791 if (!(do_dts || do_ptm))
794 /* this is a per-package concept */
795 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) ||
796 !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
799 if (tcc_activation_temp != 0) {
800 p->tcc_activation_temp = tcc_activation_temp;
804 if (get_msr(t->cpu_id, MSR_IA32_TEMPERATURE_TARGET, &msr))
807 target_c_local = (msr >> 16) & 0xFF;
812 p->tcc_activation_temp = target_c_local;
817 p->tcc_activation_temp = TJMAX_DEFAULT;
818 WARNING("turbostat plugin: cpu%d: Guessing tjMax %d C,"
819 " Please use TCCActivationTemp to specify it.",
820 t->cpu_id, p->tcc_activation_temp);
826 * Identify the functionality of the CPU
828 static int __attribute__((warn_unused_result)) probe_cpu(void) {
829 unsigned int eax, ebx, ecx, edx, max_level;
830 unsigned int fms, family, model;
833 * - EAX: Maximum Input Value for Basic CPUID Information
834 * - EBX: "Genu" (0x756e6547)
835 * - EDX: "ineI" (0x49656e69)
836 * - ECX: "ntel" (0x6c65746e)
838 max_level = ebx = ecx = edx = 0;
839 __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
840 if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
841 ERROR("turbostat plugin: Unsupported CPU (not Intel)");
846 * - EAX: Version Information: Type, Family, Model, and Stepping ID
849 * + 12-13: Processor type
850 * + 16-19: Extended Model ID
851 * + 20-27: Extended Family ID
852 * - EDX: Feature Information:
853 * + 5: Support for MSR read/write operations
855 fms = ebx = ecx = edx = 0;
856 __get_cpuid(1, &fms, &ebx, &ecx, &edx);
857 family = (fms >> 8) & 0xf;
858 model = (fms >> 4) & 0xf;
860 family += (fms >> 20) & 0xf;
861 if (family == 6 || family == 0xf)
862 model += ((fms >> 16) & 0xf) << 4;
863 if (!(edx & (1 << 5))) {
864 ERROR("turbostat plugin: Unsupported CPU (no MSR support)");
871 * + 0: Digital temperature sensor is supported if set
872 * + 6: Package thermal management is supported if set
874 * + 0: Hardware Coordination Feedback Capability (Presence of IA32_MPERF and
876 * + 3: The processor supports performance-energy bias preference if set.
877 * It also implies the presence of a new architectural MSR called
878 * IA32_ENERGY_PERF_BIAS
880 * This check is valid for both Intel and AMD
882 eax = ebx = ecx = edx = 0;
883 __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
884 do_dts = eax & (1 << 0);
885 do_ptm = eax & (1 << 6);
886 if (!(ecx & (1 << 0))) {
887 ERROR("turbostat plugin: Unsupported CPU (No APERF)");
892 * Enable or disable C states depending on the model and family
900 do_pkg_cstate = (1 << 2) | (1 << 4) | (1 << 6);
906 do_core_cstate = (1 << 1) | (1 << 6);
907 do_pkg_cstate = (1 << 6);
910 case 0x1A: /* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
911 case 0x1E: /* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper
913 case 0x1F: /* Core i7 and i5 Processor - Nehalem */
914 case 0x2E: /* Nehalem-EX Xeon - Beckton */
916 do_core_cstate = (1 << 3) | (1 << 6);
917 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
920 case 0x25: /* Westmere Client - Clarkdale, Arrandale */
921 case 0x2C: /* Westmere EP - Gulftown */
922 case 0x2F: /* Westmere-EX Xeon - Eagleton */
924 do_core_cstate = (1 << 3) | (1 << 6);
925 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
929 case 0x2D: /* SNB Xeon */
931 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
932 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
936 case 0x3E: /* IVB Xeon */
938 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
939 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
946 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
947 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
951 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
952 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) |
953 (1 << 9) | (1 << 10);
957 case 0x56: /* BDX-DE */
959 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
960 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
964 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
965 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) |
966 (1 << 9) | (1 << 10);
982 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_GFX;
986 case 0x56: /* BDX-DE */
987 do_rapl = RAPL_PKG | RAPL_DRAM;
989 case 0x2D: /* SNB Xeon */
990 case 0x3E: /* IVB Xeon */
991 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_DRAM;
995 do_rapl = RAPL_PKG | RAPL_CORES;
1001 ERROR("turbostat plugin: Unsupported CPU (family: %#x, "
1007 /* Override detected values with configuration */
1008 if (apply_config_core_cstate)
1009 do_core_cstate = config_core_cstate;
1010 if (apply_config_pkg_cstate)
1011 do_pkg_cstate = config_pkg_cstate;
1012 if (apply_config_smi)
1013 do_smi = config_smi;
1014 if (apply_config_dts)
1015 do_dts = config_dts;
1016 if (apply_config_ptm)
1017 do_ptm = config_ptm;
1018 if (apply_config_rapl)
1019 do_rapl = config_rapl;
1022 unsigned long long msr;
1023 if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1027 rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1029 rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1035 /********************
1036 * Topology Probing *
1037 ********************/
1040 * Read a single int from a file.
1042 static int __attribute__((format(printf, 1, 2)))
1043 parse_int_file(const char *fmt, ...) {
1045 char path[PATH_MAX];
1048 va_start(args, fmt);
1049 len = vsnprintf(path, sizeof(path), fmt, args);
1051 if (len < 0 || len >= PATH_MAX) {
1052 ERROR("turbostat plugin: path truncated: '%s'", path);
1057 if (parse_value_file(path, &v, DS_TYPE_DERIVE) != 0) {
1058 ERROR("turbostat plugin: Parsing \"%s\" failed.", path);
1062 return (int)v.derive;
1065 static int get_threads_on_core(unsigned int cpu) {
1072 snprintf(path, sizeof(path),
1073 "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
1074 filep = fopen(path, "r");
1076 ERROR("turbostat plugin: Failed to open '%s'", path);
1081 * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
1082 * otherwinse 1 sibling (self).
1084 matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
1095 * run func(cpu) on every cpu in /proc/stat
1096 * return max_cpu number
1098 static int __attribute__((warn_unused_result))
1099 for_all_proc_cpus(int(func)(unsigned int)) {
1101 unsigned int cpu_num;
1104 fp = fopen("/proc/stat", "r");
1106 ERROR("turbostat plugin: Failed to open /proc/stat");
1110 retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
1112 ERROR("turbostat plugin: Failed to parse /proc/stat");
1119 fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
1123 retval = func(cpu_num);
1134 * Update the stored topology.max_cpu_id
1136 static int update_max_cpu_id(unsigned int cpu) {
1137 if (topology.max_cpu_id < cpu)
1138 topology.max_cpu_id = cpu;
1142 static int mark_cpu_present(unsigned int cpu) {
1143 CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
1147 static int __attribute__((warn_unused_result))
1148 allocate_cpu_set(cpu_set_t **set, size_t *size) {
1149 *set = CPU_ALLOC(topology.max_cpu_id + 1);
1151 ERROR("turbostat plugin: Unable to allocate CPU state");
1154 *size = CPU_ALLOC_SIZE(topology.max_cpu_id + 1);
1155 CPU_ZERO_S(*size, *set);
1160 * Build a local representation of the cpu distribution
1162 static int __attribute__((warn_unused_result)) topology_probe(void) {
1164 unsigned int max_package_id, max_core_id, max_threads;
1165 max_package_id = max_core_id = max_threads = 0;
1167 /* Clean topology */
1168 free(topology.cpus);
1169 memset(&topology, 0, sizeof(topology));
1171 ret = for_all_proc_cpus(update_max_cpu_id);
1176 calloc(1, (topology.max_cpu_id + 1) * sizeof(struct cpu_topology));
1177 if (topology.cpus == NULL) {
1178 ERROR("turbostat plugin: Unable to allocate memory for CPU topology");
1182 ret = allocate_cpu_set(&cpu_present_set, &cpu_present_setsize);
1185 ret = allocate_cpu_set(&cpu_affinity_set, &cpu_affinity_setsize);
1188 ret = allocate_cpu_set(&cpu_saved_affinity_set, &cpu_saved_affinity_setsize);
1192 ret = for_all_proc_cpus(mark_cpu_present);
1198 * find max_core_id, max_package_id
1200 for (unsigned int i = 0; i <= topology.max_cpu_id; ++i) {
1201 unsigned int num_threads;
1202 struct cpu_topology *cpu = &topology.cpus[i];
1204 if (cpu_is_not_present(i)) {
1205 WARNING("turbostat plugin: cpu%d NOT PRESENT", i);
1209 ret = parse_int_file(
1210 "/sys/devices/system/cpu/cpu%d/topology/physical_package_id", i);
1214 cpu->package_id = (unsigned int)ret;
1215 if (cpu->package_id > max_package_id)
1216 max_package_id = cpu->package_id;
1218 ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", i);
1222 cpu->core_id = (unsigned int)ret;
1223 if (cpu->core_id > max_core_id)
1224 max_core_id = cpu->core_id;
1225 ret = parse_int_file(
1226 "/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", i);
1229 else if ((unsigned int)ret == i)
1230 cpu->first_core_in_package = 1;
1232 ret = get_threads_on_core(i);
1236 num_threads = (unsigned int)ret;
1237 if (num_threads > max_threads)
1238 max_threads = num_threads;
1239 ret = parse_int_file(
1240 "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", i);
1243 else if ((unsigned int)ret == i)
1244 cpu->first_thread_in_core = 1;
1246 DEBUG("turbostat plugin: cpu %d pkg %d core %d\n", i, cpu->package_id,
1249 /* Num is max + 1 (need to count 0) */
1250 topology.num_packages = max_package_id + 1;
1251 topology.num_cores = max_core_id + 1;
1252 topology.num_threads = max_threads;
1256 free(topology.cpus);
1260 /************************
1261 * Main alloc/init/free *
1262 ************************/
1264 static int allocate_counters(struct thread_data **threads,
1265 struct core_data **cores,
1266 struct pkg_data **packages) {
1267 unsigned int total_threads, total_cores;
1269 if ((topology.num_threads == 0) || (topology.num_cores == 0) ||
1270 (topology.num_packages == 0)) {
1272 "turbostat plugin: Invalid topology: %u threads, %u cores, %u packages",
1273 topology.num_threads, topology.num_cores, topology.num_packages);
1278 topology.num_threads * topology.num_cores * topology.num_packages;
1279 *threads = calloc(total_threads, sizeof(struct thread_data));
1280 if (*threads == NULL) {
1281 ERROR("turbostat plugin: calloc failed");
1285 for (unsigned int i = 0; i < total_threads; ++i)
1286 (*threads)[i].cpu_id = topology.max_cpu_id + 1;
1288 total_cores = topology.num_cores * topology.num_packages;
1289 *cores = calloc(total_cores, sizeof(struct core_data));
1290 if (*cores == NULL) {
1291 ERROR("turbostat plugin: calloc failed");
1296 *packages = calloc(topology.num_packages, sizeof(struct pkg_data));
1297 if (*packages == NULL) {
1298 ERROR("turbostat plugin: calloc failed");
1307 static void init_counter(struct thread_data *thread_base,
1308 struct core_data *core_base, struct pkg_data *pkg_base,
1309 unsigned int cpu_id) {
1310 struct thread_data *t;
1311 struct core_data *c;
1313 struct cpu_topology *cpu = &topology.cpus[cpu_id];
1315 t = GET_THREAD(thread_base, !(cpu->first_thread_in_core), cpu->core_id,
1317 c = GET_CORE(core_base, cpu->core_id, cpu->package_id);
1318 p = GET_PKG(pkg_base, cpu->package_id);
1321 if (cpu->first_thread_in_core)
1322 t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1323 if (cpu->first_core_in_package)
1324 t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1326 c->core_id = cpu->core_id;
1327 p->package_id = cpu->package_id;
1330 static void initialize_counters(void) {
1331 for (unsigned int cpu_id = 0; cpu_id <= topology.max_cpu_id; ++cpu_id) {
1332 if (cpu_is_not_present(cpu_id))
1334 init_counter(EVEN_COUNTERS, cpu_id);
1335 init_counter(ODD_COUNTERS, cpu_id);
1336 init_counter(DELTA_COUNTERS, cpu_id);
1340 static void free_all_buffers(void) {
1344 CPU_FREE(cpu_present_set);
1345 cpu_present_set = NULL;
1346 cpu_present_setsize = 0;
1348 CPU_FREE(cpu_affinity_set);
1349 cpu_affinity_set = NULL;
1350 cpu_affinity_setsize = 0;
1352 CPU_FREE(cpu_saved_affinity_set);
1353 cpu_saved_affinity_set = NULL;
1354 cpu_saved_affinity_setsize = 0;
1362 package_even = NULL;
1374 free(package_delta);
1376 thread_delta = NULL;
1378 package_delta = NULL;
1381 /**********************
1382 * Collectd functions *
1383 **********************/
1385 #define DO_OR_GOTO_ERR(something) \
1387 ret = (something); \
1392 static int setup_all_buffers(void) {
1395 DO_OR_GOTO_ERR(topology_probe());
1396 DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1397 DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1398 DO_OR_GOTO_ERR(allocate_counters(&thread_delta, &core_delta, &package_delta));
1399 initialize_counters();
1400 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1401 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, ODD_COUNTERS));
1410 static int turbostat_read(void) {
1414 if ((ret = setup_all_buffers()) < 0)
1418 if (for_all_proc_cpus(cpu_is_not_present)) {
1420 if ((ret = setup_all_buffers()) < 0)
1422 if (for_all_proc_cpus(cpu_is_not_present)) {
1423 ERROR("turbostat plugin: CPU appeared just after "
1429 /* Saving the scheduling affinity, as it will be modified by get_counters */
1430 if (sched_getaffinity(0, cpu_saved_affinity_setsize,
1431 cpu_saved_affinity_set) != 0) {
1432 ERROR("turbostat plugin: Unable to save the CPU affinity");
1437 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1439 time_even = cdtime();
1447 if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
1449 time_odd = cdtime();
1451 time_delta = time_odd - time_even;
1452 if ((ret = for_all_cpus_delta(ODD_COUNTERS, EVEN_COUNTERS)) < 0)
1454 if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1457 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1459 time_even = cdtime();
1461 time_delta = time_even - time_odd;
1462 if ((ret = for_all_cpus_delta(EVEN_COUNTERS, ODD_COUNTERS)) < 0)
1464 if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1470 * Let's restore the affinity
1471 * This might fail if the number of CPU changed, but we can't do anything in
1474 (void)sched_setaffinity(0, cpu_saved_affinity_setsize,
1475 cpu_saved_affinity_set);
1479 static int check_permissions(void) {
1481 if (getuid() == 0) {
1482 /* We have everything we need */
1484 #if !defined(HAVE_SYS_CAPABILITY_H) && !defined(CAP_SYS_RAWIO)
1486 ERROR("turbostat plugin: Initialization failed: this plugin "
1487 "requires collectd to run as root");
1490 #else /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1495 if (check_capability(CAP_SYS_RAWIO) != 0) {
1496 WARNING("turbostat plugin: Collectd doesn't have the "
1497 "CAP_SYS_RAWIO capability. If you don't want to run "
1498 "collectd as root, try running \"setcap "
1499 "cap_sys_rawio=ep\" on collectd binary");
1503 if (euidaccess("/dev/cpu/0/msr", R_OK)) {
1504 WARNING("turbostat plugin: Collectd cannot open "
1505 "/dev/cpu/0/msr. If you don't want to run collectd as "
1506 "root, you need to change the ownership (chown) and "
1507 "permissions on /dev/cpu/*/msr to allow such access");
1512 ERROR("turbostat plugin: Initialization failed: this plugin "
1513 "requires collectd to either to run as root or give "
1514 "collectd a special capability (CAP_SYS_RAWIO) and read "
1515 "access to /dev/cpu/*/msr (see previous warnings)");
1517 #endif /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1520 static int turbostat_init(void) {
1524 if (stat("/dev/cpu/0/msr", &sb)) {
1525 ERROR("turbostat plugin: Initialization failed: /dev/cpu/0/msr "
1526 "does not exist while the CPU supports MSR. You may be "
1527 "missing the corresponding kernel module, please try '# "
1532 DO_OR_GOTO_ERR(check_permissions());
1534 DO_OR_GOTO_ERR(probe_cpu());
1536 DO_OR_GOTO_ERR(setup_all_buffers());
1538 plugin_register_read(PLUGIN_NAME, turbostat_read);
1546 static int turbostat_config(const char *key, const char *value) {
1547 long unsigned int tmp_val;
1550 if (strcasecmp("CoreCstates", key) == 0) {
1551 tmp_val = strtoul(value, &end, 0);
1552 if (*end != '\0' || tmp_val > UINT_MAX) {
1553 ERROR("turbostat plugin: Invalid CoreCstates '%s'", value);
1556 config_core_cstate = (unsigned int)tmp_val;
1557 apply_config_core_cstate = 1;
1558 } else if (strcasecmp("PackageCstates", key) == 0) {
1559 tmp_val = strtoul(value, &end, 0);
1560 if (*end != '\0' || tmp_val > UINT_MAX) {
1561 ERROR("turbostat plugin: Invalid PackageCstates '%s'", value);
1564 config_pkg_cstate = (unsigned int)tmp_val;
1565 apply_config_pkg_cstate = 1;
1566 } else if (strcasecmp("SystemManagementInterrupt", key) == 0) {
1567 config_smi = IS_TRUE(value);
1568 apply_config_smi = 1;
1569 } else if (strcasecmp("DigitalTemperatureSensor", key) == 0) {
1570 config_dts = IS_TRUE(value);
1571 apply_config_dts = 1;
1572 } else if (strcasecmp("PackageThermalManagement", key) == 0) {
1573 config_ptm = IS_TRUE(value);
1574 apply_config_ptm = 1;
1575 } else if (strcasecmp("LogicalCoreNames", key) == 0) {
1576 config_lcn = IS_TRUE(value);
1577 } else if (strcasecmp("RunningAveragePowerLimit", key) == 0) {
1578 tmp_val = strtoul(value, &end, 0);
1579 if (*end != '\0' || tmp_val > UINT_MAX) {
1580 ERROR("turbostat plugin: Invalid RunningAveragePowerLimit '%s'", value);
1583 config_rapl = (unsigned int)tmp_val;
1584 apply_config_rapl = 1;
1585 } else if (strcasecmp("TCCActivationTemp", key) == 0) {
1586 tmp_val = strtoul(value, &end, 0);
1587 if (*end != '\0' || tmp_val > UINT_MAX) {
1588 ERROR("turbostat plugin: Invalid TCCActivationTemp '%s'", value);
1591 tcc_activation_temp = (unsigned int)tmp_val;
1593 ERROR("turbostat plugin: Invalid configuration option '%s'", key);
1599 void module_register(void) {
1600 plugin_register_init(PLUGIN_NAME, turbostat_init);
1601 plugin_register_config(PLUGIN_NAME, turbostat_config, config_keys,