![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
f3be6020aaa37575f56ef0039d900d8d6c5bb1e7
1 /*
2 * turbostat -- Log CPU frequency and C-state residency
3 * on modern Intel turbo-capable processors for collectd.
4 *
5 * Based on the 'turbostat' tool of the Linux kernel, found at
6 * linux/tools/power/x86/turbostat/turbostat.c:
7 * ----
8 * Copyright (c) 2013 Intel Corporation.
9 * Len Brown <len.brown@intel.com>
10 *
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.
14 *
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
18 * more details.
19 *
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.
23 * ----
24 * Ported to collectd by Vincent Brillault <git@lerya.net>
25 */
27 /*
28 * _GNU_SOURCE is required because of the following functions:
29 * - CPU_ISSET_S
30 * - CPU_ZERO_S
31 * - CPU_SET_S
32 * - CPU_FREE
33 * - CPU_ALLOC
34 * - CPU_ALLOC_SIZE
35 */
36 #define _GNU_SOURCE
38 #include "collectd.h"
39 #include "common.h"
40 #include "plugin.h"
41 #include "utils_time.h"
43 #include <asm/msr-index.h>
44 #include <stdarg.h>
45 #include <stdio.h>
46 #include <err.h>
47 #include <unistd.h>
48 #include <sys/types.h>
49 #include <sys/wait.h>
50 #include <sys/stat.h>
51 #include <sys/resource.h>
52 #include <fcntl.h>
53 #include <signal.h>
54 #include <stdlib.h>
55 #include <dirent.h>
56 #include <string.h>
57 #include <ctype.h>
58 #include <sched.h>
59 #include <cpuid.h>
60 #include <sys/capability.h>
62 #define PLUGIN_NAME "turbostat"
64 /*
65 * This tool uses the Model-Specific Registers (MSRs) present on Intel processors.
66 * The general description each of these registers, depending on the architecture,
67 * can be found in the Intel® 64 and IA-32 Architectures Software Developer Manual,
68 * Volume 3 Chapter 35.
69 */
71 /*
72 * If set, aperf_mperf_unstable disables a/mperf based stats.
73 * This includes: C0 & C1 states, frequency
74 *
75 * This value is automatically set if mperf or aperf go backward
76 */
77 static _Bool aperf_mperf_unstable;
79 /*
80 * Bitmask of the list of core C states supported by the processor.
81 * Currently supported C-states (by this plugin): 3, 6, 7
82 */
83 static unsigned int do_core_cstate;
84 static unsigned int config_core_cstate;
85 static _Bool apply_config_core_cstate;
87 /*
88 * Bitmask of the list of pacages C states supported by the processor.
89 * Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
90 */
91 static unsigned int do_pkg_cstate;
92 static unsigned int config_pkg_cstate;
93 static _Bool apply_config_pkg_cstate;
95 /*
96 * Boolean indicating if the processor supports 'I/O System-Management Interrupt counter'
97 */
98 static _Bool do_smi;
99 static _Bool config_smi;
100 static _Bool apply_config_smi;
102 /*
103 * Boolean indicating if the processor supports 'Digital temperature sensor'
104 * This feature enables the monitoring of the temperature of each core
105 *
106 * This feature has two limitations:
107 * - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature might be wrong
108 * - Temperatures above the tcc_activation_temp are not recorded
109 */
110 static _Bool do_dts;
111 static _Bool config_dts;
112 static _Bool apply_config_dts;
114 /*
115 * Boolean indicating if the processor supports 'Package thermal management'
116 * This feature allows the monitoring of the temperature of each package
117 *
118 * This feature has two limitations:
119 * - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature might be wrong
120 * - Temperatures above the tcc_activation_temp are not recorded
121 */
122 static _Bool do_ptm;
123 static _Bool config_ptm;
124 static _Bool apply_config_ptm;
126 /*
127 * Thermal Control Circuit Activation Temperature as configured by the user.
128 * This override the automated detection via MSR_IA32_TEMPERATURE_TARGET
129 * and should only be used if the automated detection fails.
130 */
131 static unsigned int tcc_activation_temp;
133 static unsigned int do_rapl;
134 static unsigned int config_rapl;
135 static _Bool apply_config_rapl;
136 static double rapl_energy_units;
138 #define RAPL_PKG (1 << 0)
139 /* 0x610 MSR_PKG_POWER_LIMIT */
140 /* 0x611 MSR_PKG_ENERGY_STATUS */
141 #define RAPL_DRAM (1 << 1)
142 /* 0x618 MSR_DRAM_POWER_LIMIT */
143 /* 0x619 MSR_DRAM_ENERGY_STATUS */
144 /* 0x61c MSR_DRAM_POWER_INFO */
145 #define RAPL_CORES (1 << 2)
146 /* 0x638 MSR_PP0_POWER_LIMIT */
147 /* 0x639 MSR_PP0_ENERGY_STATUS */
149 #define RAPL_GFX (1 << 3)
150 /* 0x640 MSR_PP1_POWER_LIMIT */
151 /* 0x641 MSR_PP1_ENERGY_STATUS */
152 /* 0x642 MSR_PP1_POLICY */
153 #define TJMAX_DEFAULT 100
155 static cpu_set_t *cpu_present_set, *cpu_affinity_set, *cpu_saved_affinity_set;
156 static size_t cpu_present_setsize, cpu_affinity_setsize, 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;
164 unsigned int cpu_id;
165 unsigned int flags;
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 + \
205 (pkg_no) * topology.num_cores * topology.num_threads + \
206 (core_no) * topology.num_threads + \
207 (thread_no))
208 #define GET_CORE(core_base, core_no, pkg_no) \
209 (core_base + \
210 (pkg_no) * topology.num_cores + \
211 (core_no))
212 #define GET_PKG(pkg_base, pkg_no) (pkg_base + pkg_no)
214 struct cpu_topology {
215 int package_id;
216 int core_id;
217 _Bool first_core_in_package;
218 _Bool first_thread_in_core;
219 };
221 static struct topology {
222 int max_cpu_id;
223 int num_packages;
224 int num_cores;
225 int num_threads;
226 struct cpu_topology *cpus;
227 } topology;
229 static cdtime_t time_even, time_odd, time_delta;
231 static const char *config_keys[] =
232 {
233 "CoreCstates",
234 "PackageCstates",
235 "SystemManagementInterrupt",
236 "DigitalTemperatureSensor",
237 "PackageThermalManagement",
238 "TCCActivationTemp",
239 "RunningAveragePowerLimit",
240 };
241 static const int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
243 /*****************************
244 * MSR Manipulation helpers *
245 *****************************/
247 /*
248 * Open a MSR device for reading
249 * Can change the scheduling affinity of the current process if multiple_read is 1
250 */
251 static int __attribute__((warn_unused_result))
252 open_msr(int cpu, _Bool multiple_read)
253 {
254 char pathname[32];
255 int fd;
257 /*
258 * If we need to do multiple read, let's migrate to the CPU
259 * Otherwise, we would lose time calling functions on another CPU
260 *
261 * If we are not yet initialized (cpu_affinity_setsize = 0),
262 * we need to skip this optimisation.
263 */
264 if (multiple_read && cpu_affinity_setsize) {
265 CPU_ZERO_S(cpu_affinity_setsize, cpu_affinity_set);
266 CPU_SET_S(cpu, cpu_affinity_setsize, cpu_affinity_set);
267 if (sched_setaffinity(0, cpu_affinity_setsize, cpu_affinity_set) == -1) {
268 ERROR("Turbostat plugin: Could not migrate to CPU %d", cpu);
269 return -1;
270 }
271 }
273 ssnprintf(pathname, sizeof(pathname), "/dev/cpu/%d/msr", cpu);
274 fd = open(pathname, O_RDONLY);
275 if (fd < 0) {
276 ERROR("Turbostat plugin: failed to open %s", pathname);
277 return -1;
278 }
279 return fd;
280 }
282 /*
283 * Read a single MSR from an open file descriptor
284 */
285 static int __attribute__((warn_unused_result))
286 read_msr(int fd, off_t offset, unsigned long long *msr)
287 {
288 ssize_t retval;
290 retval = pread(fd, msr, sizeof *msr, offset);
292 if (retval != sizeof *msr) {
293 ERROR("Turbostat plugin: MSR offset 0x%llx read failed",
294 (unsigned long long)offset);
295 return -1;
296 }
297 return 0;
298 }
300 /*
301 * Open a MSR device for reading, read the value asked for and close it.
302 * This call will not affect the scheduling affinity of this thread.
303 */
304 static int __attribute__((warn_unused_result))
305 get_msr(int cpu, off_t offset, unsigned long long *msr)
306 {
307 ssize_t retval;
308 int fd;
310 fd = open_msr(cpu, 0);
311 if (fd < 0)
312 return fd;
313 retval = read_msr(fd, offset, msr);
314 close(fd);
315 return retval;
316 }
319 /********************************
320 * Raw data acquisition (1 CPU) *
321 ********************************/
323 /*
324 * Read every data avalaible for a single CPU
325 *
326 * Core data is shared for all threads in one core: extracted only for the first thread
327 * Package data is shared for all core in one package: extracted only for the first thread of the first core
328 *
329 * Side effect: migrates to the targeted CPU
330 */
331 static int __attribute__((warn_unused_result))
332 get_counters(struct thread_data *t, struct core_data *c, struct pkg_data *p)
333 {
334 int cpu = t->cpu_id;
335 unsigned long long msr;
336 int msr_fd;
337 int retval = 0;
339 msr_fd = open_msr(cpu, 1);
340 if (msr_fd < 0)
341 return msr_fd;
343 #define READ_MSR(msr, dst) \
344 do { \
345 if (read_msr(msr_fd, msr, dst)) { \
346 ERROR("Turbostat plugin: Unable to read " #msr); \
347 retval = -1; \
348 goto out; \
349 } \
350 } while (0)
352 READ_MSR(MSR_IA32_TSC, &t->tsc);
354 READ_MSR(MSR_IA32_APERF, &t->aperf);
355 READ_MSR(MSR_IA32_MPERF, &t->mperf);
357 if (do_smi) {
358 READ_MSR(MSR_SMI_COUNT, &msr);
359 t->smi_count = msr & 0xFFFFFFFF;
360 }
362 /* collect core counters only for 1st thread in core */
363 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE)) {
364 retval = 0;
365 goto out;
366 }
368 if (do_core_cstate & (1 << 3))
369 READ_MSR(MSR_CORE_C3_RESIDENCY, &c->c3);
370 if (do_core_cstate & (1 << 6))
371 READ_MSR(MSR_CORE_C6_RESIDENCY, &c->c6);
372 if (do_core_cstate & (1 << 7))
373 READ_MSR(MSR_CORE_C7_RESIDENCY, &c->c7);
375 if (do_dts) {
376 READ_MSR(MSR_IA32_THERM_STATUS, &msr);
377 c->core_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
378 }
380 /* collect package counters only for 1st core in package */
381 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)) {
382 retval = 0;
383 goto out;
384 }
386 if (do_pkg_cstate & (1 << 2))
387 READ_MSR(MSR_PKG_C2_RESIDENCY, &p->pc2);
388 if (do_pkg_cstate & (1 << 3))
389 READ_MSR(MSR_PKG_C3_RESIDENCY, &p->pc3);
390 if (do_pkg_cstate & (1 << 6))
391 READ_MSR(MSR_PKG_C6_RESIDENCY, &p->pc6);
392 if (do_pkg_cstate & (1 << 7))
393 READ_MSR(MSR_PKG_C7_RESIDENCY, &p->pc7);
394 if (do_pkg_cstate & (1 << 8))
395 READ_MSR(MSR_PKG_C8_RESIDENCY, &p->pc8);
396 if (do_pkg_cstate & (1 << 9))
397 READ_MSR(MSR_PKG_C9_RESIDENCY, &p->pc9);
398 if (do_pkg_cstate & (1 << 10))
399 READ_MSR(MSR_PKG_C10_RESIDENCY, &p->pc10);
401 if (do_rapl & RAPL_PKG) {
402 READ_MSR(MSR_PKG_ENERGY_STATUS, &msr);
403 p->energy_pkg = msr & 0xFFFFFFFF;
404 }
405 if (do_rapl & RAPL_CORES) {
406 READ_MSR(MSR_PP0_ENERGY_STATUS, &msr);
407 p->energy_cores = msr & 0xFFFFFFFF;
408 }
409 if (do_rapl & RAPL_DRAM) {
410 READ_MSR(MSR_DRAM_ENERGY_STATUS, &msr);
411 p->energy_dram = msr & 0xFFFFFFFF;
412 }
413 if (do_rapl & RAPL_GFX) {
414 READ_MSR(MSR_PP1_ENERGY_STATUS, &msr);
415 p->energy_gfx = msr & 0xFFFFFFFF;
416 }
417 if (do_ptm) {
418 READ_MSR(MSR_IA32_PACKAGE_THERM_STATUS, &msr);
419 p->pkg_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
420 }
422 out:
423 close(msr_fd);
424 return retval;
425 }
428 /**********************************
429 * Evaluating the changes (1 CPU) *
430 **********************************/
432 /*
433 * Extract the evolution old->new in delta at a package level
434 * (some are not new-delta, e.g. temperature)
435 */
436 static inline void
437 delta_package(struct pkg_data *delta, const struct pkg_data *new, const struct pkg_data *old)
438 {
439 delta->pc2 = new->pc2 - old->pc2;
440 delta->pc3 = new->pc3 - old->pc3;
441 delta->pc6 = new->pc6 - old->pc6;
442 delta->pc7 = new->pc7 - old->pc7;
443 delta->pc8 = new->pc8 - old->pc8;
444 delta->pc9 = new->pc9 - old->pc9;
445 delta->pc10 = new->pc10 - old->pc10;
446 delta->pkg_temp_c = new->pkg_temp_c;
448 delta->energy_pkg = new->energy_pkg - old->energy_pkg;
449 delta->energy_cores = new->energy_cores - old->energy_cores;
450 delta->energy_gfx = new->energy_gfx - old->energy_gfx;
451 delta->energy_dram = new->energy_dram - old->energy_dram;
452 }
454 /*
455 * Extract the evolution old->new in delta at a core level
456 * (some are not new-delta, e.g. temperature)
457 */
458 static inline void
459 delta_core(struct core_data *delta, const struct core_data *new, const struct core_data *old)
460 {
461 delta->c3 = new->c3 - old->c3;
462 delta->c6 = new->c6 - old->c6;
463 delta->c7 = new->c7 - old->c7;
464 delta->core_temp_c = new->core_temp_c;
465 }
467 /*
468 * Extract the evolution old->new in delta at a package level
469 * core_delta is required for c1 estimation (tsc - c0 - all core cstates)
470 */
471 static inline int __attribute__((warn_unused_result))
472 delta_thread(struct thread_data *delta, const struct thread_data *new, const struct thread_data *old,
473 const struct core_data *core_delta)
474 {
475 delta->tsc = new->tsc - old->tsc;
477 /* check for TSC < 1 Mcycles over interval */
478 if (delta->tsc < (1000 * 1000)) {
479 WARNING("Turbostat plugin: Insanely slow TSC rate, TSC stops "
480 "in idle? You can disable all c-states by booting with"
481 " 'idle=poll' or just the deep ones with"
482 " 'processor.max_cstate=1'");
483 return -1;
484 }
486 delta->c1 = new->c1 - old->c1;
488 if ((new->aperf > old->aperf) && (new->mperf > old->mperf)) {
489 delta->aperf = new->aperf - old->aperf;
490 delta->mperf = new->mperf - old->mperf;
491 } else {
492 if (!aperf_mperf_unstable) {
493 WARNING("Turbostat plugin: APERF or MPERF went "
494 "backwards. Frequency results do not cover "
495 "the entire interval. Fix this by running "
496 "Linux-2.6.30 or later.");
498 aperf_mperf_unstable = 1;
499 }
500 }
502 /*
503 * As counter collection is not atomic,
504 * it is possible for mperf's non-halted cycles + idle states
505 * to exceed TSC's all cycles: show c1 = 0% in that case.
506 */
507 if ((delta->mperf + core_delta->c3 + core_delta->c6 + core_delta->c7) > delta->tsc)
508 delta->c1 = 0;
509 else {
510 /* normal case, derive c1 */
511 delta->c1 = delta->tsc - delta->mperf - core_delta->c3
512 - core_delta->c6 - core_delta->c7;
513 }
515 if (delta->mperf == 0) {
516 WARNING("Turbostat plugin: cpu%d MPERF 0!", old->cpu_id);
517 delta->mperf = 1; /* divide by 0 protection */
518 }
520 if (do_smi)
521 delta->smi_count = new->smi_count - old->smi_count;
523 return 0;
524 }
526 /**********************************
527 * Submitting the results (1 CPU) *
528 **********************************/
530 /*
531 * Submit one gauge value
532 */
533 static void
534 turbostat_submit (const char *plugin_instance,
535 const char *type, const char *type_instance,
536 gauge_t value)
537 {
538 value_list_t vl = VALUE_LIST_INIT;
539 value_t v;
541 v.gauge = value;
542 vl.values = &v;
543 vl.values_len = 1;
544 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
545 sstrncpy (vl.plugin, PLUGIN_NAME, sizeof (vl.plugin));
546 if (plugin_instance != NULL)
547 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
548 sstrncpy (vl.type, type, sizeof (vl.type));
549 if (type_instance != NULL)
550 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
552 plugin_dispatch_values (&vl);
553 }
555 /*
556 * Submit every data for a single CPU
557 *
558 * Core data is shared for all threads in one core: submitted only for the first thread
559 * Package data is shared for all core in one package: submitted only for the first thread of the first core
560 */
561 static int
562 submit_counters(struct thread_data *t, struct core_data *c, struct pkg_data *p)
563 {
564 char name[DATA_MAX_NAME_LEN];
565 double interval_float;
567 interval_float = CDTIME_T_TO_DOUBLE(time_delta);
569 ssnprintf(name, sizeof(name), "cpu%02d", t->cpu_id);
571 if (!aperf_mperf_unstable)
572 turbostat_submit(name, "percent", "c0", 100.0 * t->mperf/t->tsc);
573 if (!aperf_mperf_unstable)
574 turbostat_submit(name, "percent", "c1", 100.0 * t->c1/t->tsc);
576 turbostat_submit("Average", "frequency", name, 1.0 / 1000000 * t->aperf / interval_float);
578 if ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc)))
579 turbostat_submit("Buzy", "frequency", name, 1.0 * t->tsc / 1000000 * t->aperf / t->mperf / interval_float);
581 /* Sanity check (should stay stable) */
582 turbostat_submit("TSC", "gauge", name, 1.0 * t->tsc / 1000000 / interval_float);
584 /* SMI */
585 if (do_smi)
586 turbostat_submit(NULL, "current", name, t->smi_count);
588 /* submit per-core data only for 1st thread in core */
589 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
590 goto done;
592 ssnprintf(name, sizeof(name), "core%02d", c->core_id);
594 if (do_core_cstate & (1 << 3))
595 turbostat_submit(name, "percent", "c3", 100.0 * c->c3/t->tsc);
596 if (do_core_cstate & (1 << 6))
597 turbostat_submit(name, "percent", "c6", 100.0 * c->c6/t->tsc);
598 if (do_core_cstate & (1 << 7))
599 turbostat_submit(name, "percent", "c7", 100.0 * c->c7/t->tsc);
601 if (do_dts)
602 turbostat_submit(NULL, "temperature", name, c->core_temp_c);
604 /* submit per-package data only for 1st core in package */
605 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
606 goto done;
608 ssnprintf(name, sizeof(name), "pkg%02d", p->package_id);
610 if (do_ptm)
611 turbostat_submit(NULL, "temperature", name, p->pkg_temp_c);
613 if (do_pkg_cstate & (1 << 2))
614 turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2/t->tsc);
615 if (do_pkg_cstate & (1 << 3))
616 turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3/t->tsc);
617 if (do_pkg_cstate & (1 << 6))
618 turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6/t->tsc);
619 if (do_pkg_cstate & (1 << 7))
620 turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7/t->tsc);
621 if (do_pkg_cstate & (1 << 8))
622 turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8/t->tsc);
623 if (do_pkg_cstate & (1 << 9))
624 turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9/t->tsc);
625 if (do_pkg_cstate & (1 << 10))
626 turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10/t->tsc);
628 if (do_rapl) {
629 if (do_rapl & RAPL_PKG)
630 turbostat_submit(name, "power", "Pkg_W", p->energy_pkg * rapl_energy_units / interval_float);
631 if (do_rapl & RAPL_CORES)
632 turbostat_submit(name, "power", "Cor_W", p->energy_cores * rapl_energy_units / interval_float);
633 if (do_rapl & RAPL_GFX)
634 turbostat_submit(name, "power", "GFX_W", p->energy_gfx * rapl_energy_units / interval_float);
635 if (do_rapl & RAPL_DRAM)
636 turbostat_submit(name, "power", "RAM_W", p->energy_dram * rapl_energy_units / interval_float);
637 }
638 done:
639 return 0;
640 }
643 /**********************************
644 * Looping function over all CPUs *
645 **********************************/
647 /*
648 * Check if a given cpu id is in our compiled list of existing CPUs
649 */
650 static int
651 cpu_is_not_present(int cpu)
652 {
653 return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
654 }
656 /*
657 * Loop on all CPUs in topological order
658 *
659 * Skip non-present cpus
660 * Return the error code at the first error or 0
661 */
662 static int __attribute__((warn_unused_result))
663 for_all_cpus(int (func)(struct thread_data *, struct core_data *, struct pkg_data *),
664 struct thread_data *thread_base, struct core_data *core_base, struct pkg_data *pkg_base)
665 {
666 int retval, pkg_no, core_no, thread_no;
668 for (pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
669 for (core_no = 0; core_no < topology.num_cores; ++core_no) {
670 for (thread_no = 0; thread_no < topology.num_threads; ++thread_no) {
671 struct thread_data *t;
672 struct core_data *c;
673 struct pkg_data *p;
675 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
677 if (cpu_is_not_present(t->cpu_id))
678 continue;
680 c = GET_CORE(core_base, core_no, pkg_no);
681 p = GET_PKG(pkg_base, pkg_no);
683 retval = func(t, c, p);
684 if (retval)
685 return retval;
686 }
687 }
688 }
689 return 0;
690 }
692 /*
693 * Dedicated loop: Extract every data evolution for all CPU
694 *
695 * Skip non-present cpus
696 * Return the error code at the first error or 0
697 *
698 * Core data is shared for all threads in one core: extracted only for the first thread
699 * Package data is shared for all core in one package: extracted only for the first thread of the first core
700 */
701 static int __attribute__((warn_unused_result))
702 for_all_cpus_delta(const struct thread_data *thread_new_base, const struct core_data *core_new_base, const struct pkg_data *pkg_new_base,
703 const struct thread_data *thread_old_base, const struct core_data *core_old_base, const struct pkg_data *pkg_old_base)
704 {
705 int retval, pkg_no, core_no, thread_no;
707 for (pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
708 for (core_no = 0; core_no < topology.num_cores; ++core_no) {
709 for (thread_no = 0; thread_no < topology.num_threads; ++thread_no) {
710 struct thread_data *t_delta;
711 const struct thread_data *t_old, *t_new;
712 struct core_data *c_delta;
714 /* Get correct pointers for threads */
715 t_delta = GET_THREAD(thread_delta, thread_no, core_no, pkg_no);
716 t_new = GET_THREAD(thread_new_base, thread_no, core_no, pkg_no);
717 t_old = GET_THREAD(thread_old_base, thread_no, core_no, pkg_no);
719 /* Skip threads that disappeared */
720 if (cpu_is_not_present(t_delta->cpu_id))
721 continue;
723 /* c_delta is always required for delta_thread */
724 c_delta = GET_CORE(core_delta, core_no, pkg_no);
726 /* calculate core delta only for 1st thread in core */
727 if (t_new->flags & CPU_IS_FIRST_THREAD_IN_CORE) {
728 const struct core_data *c_old, *c_new;
730 c_new = GET_CORE(core_new_base, core_no, pkg_no);
731 c_old = GET_CORE(core_old_base, core_no, pkg_no);
733 delta_core(c_delta, c_new, c_old);
734 }
736 /* Always calculate thread delta */
737 retval = delta_thread(t_delta, t_new, t_old, c_delta);
738 if (retval)
739 return retval;
741 /* calculate package delta only for 1st core in package */
742 if (t_new->flags & CPU_IS_FIRST_CORE_IN_PACKAGE) {
743 struct pkg_data *p_delta;
744 const struct pkg_data *p_old, *p_new;
746 p_delta = GET_PKG(package_delta, pkg_no);
747 p_new = GET_PKG(pkg_new_base, pkg_no);
748 p_old = GET_PKG(pkg_old_base, pkg_no);
750 delta_package(p_delta, p_new, p_old);
751 }
752 }
753 }
754 }
755 return 0;
756 }
759 /***************
760 * CPU Probing *
761 ***************/
763 /*
764 * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
765 * the Thermal Control Circuit (TCC) activates.
766 * This is usually equal to tjMax.
767 *
768 * Older processors do not have this MSR, so there we guess,
769 * but also allow conficuration over-ride with "TCCActivationTemp".
770 *
771 * Several MSR temperature values are in units of degrees-C
772 * below this value, including the Digital Thermal Sensor (DTS),
773 * Package Thermal Management Sensor (PTM), and thermal event thresholds.
774 */
775 static int __attribute__((warn_unused_result))
776 set_temperature_target(struct thread_data *t, struct core_data *c, struct pkg_data *p)
777 {
778 unsigned long long msr;
779 unsigned int target_c_local;
781 /* tcc_activation_temp is used only for dts or ptm */
782 if (!(do_dts || do_ptm))
783 return 0;
785 /* this is a per-package concept */
786 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) || !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
787 return 0;
789 if (tcc_activation_temp != 0) {
790 p->tcc_activation_temp = tcc_activation_temp;
791 return 0;
792 }
794 if (get_msr(t->cpu_id, MSR_IA32_TEMPERATURE_TARGET, &msr))
795 goto guess;
797 target_c_local = (msr >> 16) & 0xFF;
799 if (!target_c_local)
800 goto guess;
802 p->tcc_activation_temp = target_c_local;
804 return 0;
806 guess:
807 p->tcc_activation_temp = TJMAX_DEFAULT;
808 WARNING("Turbostat plugin: cpu%d: Guessing tjMax %d C,"
809 " Please use TCCActivationTemp to specify it.",
810 t->cpu_id, p->tcc_activation_temp);
812 return 0;
813 }
815 /*
816 * Identify the functionality of the CPU
817 */
818 static int __attribute__((warn_unused_result))
819 probe_cpu()
820 {
821 unsigned int eax, ebx, ecx, edx, max_level;
822 unsigned int fms, family, model;
824 /* CPUID(0):
825 * - EAX: Maximum Input Value for Basic CPUID Information
826 * - EBX: "Genu" (0x756e6547)
827 * - EDX: "ineI" (0x49656e69)
828 * - ECX: "ntel" (0x6c65746e)
829 */
830 max_level = ebx = ecx = edx = 0;
831 __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
832 if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
833 ERROR("Turbostat plugin: Unsupported CPU (not Intel)");
834 return -1;
835 }
837 /* CPUID(1):
838 * - EAX: Version Information: Type, Family, Model, and Stepping ID
839 * + 4-7: Model ID
840 * + 8-11: Family ID
841 * + 12-13: Processor type
842 * + 16-19: Extended Model ID
843 * + 20-27: Extended Family ID
844 * - EDX: Feature Information:
845 * + 5: Support for MSR read/write operations
846 */
847 fms = ebx = ecx = edx = 0;
848 __get_cpuid(1, &fms, &ebx, &ecx, &edx);
849 family = (fms >> 8) & 0xf;
850 model = (fms >> 4) & 0xf;
851 if (family == 0xf)
852 family += (fms >> 20) & 0xf;
853 if (family == 6 || family == 0xf)
854 model += ((fms >> 16) & 0xf) << 4;
855 if (!(edx & (1 << 5))) {
856 ERROR("Turbostat plugin: Unsupported CPU (no MSR support)");
857 return -1;
858 }
860 /*
861 * CPUID(6):
862 * - EAX:
863 * + 0: Digital temperature sensor is supported if set
864 * + 6: Package thermal management is supported if set
865 * - ECX:
866 * + 0: Hardware Coordination Feedback Capability (Presence of IA32_MPERF and IA32_APERF).
867 * + 3: The processor supports performance-energy bias preference if set.
868 * It also implies the presence of a new architectural MSR called IA32_ENERGY_PERF_BIAS
869 *
870 * This check is valid for both Intel and AMD
871 */
872 eax = ebx = ecx = edx = 0;
873 __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
874 do_dts = eax & (1 << 0);
875 do_ptm = eax & (1 << 6);
876 if (!(ecx & (1 << 0))) {
877 ERROR("Turbostat plugin: Unsupported CPU (No APERF)");
878 return -1;
879 }
881 /*
882 * Enable or disable C states depending on the model and family
883 */
884 if (family == 6) {
885 switch (model) {
886 /* Atom (partial) */
887 case 0x27:
888 do_smi = 0;
889 do_core_cstate = 0;
890 do_pkg_cstate = (1 << 2) | (1 << 4) | (1 << 6);
891 break;
892 /* Silvermont */
893 case 0x37: /* BYT */
894 case 0x4D: /* AVN */
895 do_smi = 1;
896 do_core_cstate = (1 << 1) | (1 << 6);
897 do_pkg_cstate = (1 << 6);
898 break;
899 /* Nehalem */
900 case 0x1A: /* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
901 case 0x1E: /* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper Forest */
902 case 0x1F: /* Core i7 and i5 Processor - Nehalem */
903 case 0x2E: /* Nehalem-EX Xeon - Beckton */
904 do_smi = 1;
905 do_core_cstate = (1 << 3) | (1 << 6);
906 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
907 break;
908 /* Westmere */
909 case 0x25: /* Westmere Client - Clarkdale, Arrandale */
910 case 0x2C: /* Westmere EP - Gulftown */
911 case 0x2F: /* Westmere-EX Xeon - Eagleton */
912 do_smi = 1;
913 do_core_cstate = (1 << 3) | (1 << 6);
914 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
915 break;
916 /* Sandy Bridge */
917 case 0x2A: /* SNB */
918 case 0x2D: /* SNB Xeon */
919 do_smi = 1;
920 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
921 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
922 break;
923 /* Ivy Bridge */
924 case 0x3A: /* IVB */
925 case 0x3E: /* IVB Xeon */
926 do_smi = 1;
927 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
928 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
929 break;
930 /* Haswell Bridge */
931 case 0x3C: /* HSW */
932 case 0x3F: /* HSW */
933 case 0x46: /* HSW */
934 do_smi = 1;
935 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
936 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
937 break;
938 case 0x45: /* HSW */
939 do_smi = 1;
940 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
941 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9) | (1 << 10);
942 break;
943 /* Broadwel */
944 case 0x4F: /* BDW */
945 case 0x56: /* BDX-DE */
946 do_smi = 1;
947 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
948 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
949 break;
950 case 0x3D: /* BDW */
951 do_smi = 1;
952 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
953 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9) | (1 << 10);
954 break;
955 default:
956 do_smi = 0;
957 do_core_cstate = 0;
958 do_pkg_cstate = 0;
959 break;
960 }
961 switch (model) {
962 case 0x2A: /* SNB */
963 case 0x3A: /* IVB */
964 case 0x3C: /* HSW */
965 case 0x45: /* HSW */
966 case 0x46: /* HSW */
967 case 0x3D: /* BDW */
968 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_GFX;
969 break;
970 case 0x3F: /* HSX */
971 case 0x4F: /* BDX */
972 case 0x56: /* BDX-DE */
973 do_rapl = RAPL_PKG | RAPL_DRAM ;
974 break;
975 case 0x2D: /* SNB Xeon */
976 case 0x3E: /* IVB Xeon */
977 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_DRAM;
978 break;
979 case 0x37: /* BYT */
980 case 0x4D: /* AVN */
981 do_rapl = RAPL_PKG | RAPL_CORES;
982 break;
983 default:
984 do_rapl = 0;
985 }
986 } else {
987 ERROR("Turbostat plugin: Unsupported CPU (family: %#x, "
988 "model: %#x)", family, model);
989 return -1;
990 }
992 /* Override detected values with configuration */
993 if (apply_config_core_cstate)
994 do_core_cstate = config_core_cstate;
995 if (apply_config_pkg_cstate)
996 do_pkg_cstate = config_pkg_cstate;
997 if (apply_config_smi)
998 do_smi = config_smi;
999 if (apply_config_dts)
1000 do_dts = config_dts;
1001 if (apply_config_ptm)
1002 do_ptm = config_ptm;
1003 if (apply_config_rapl)
1004 do_rapl = config_rapl;
1006 if (do_rapl) {
1007 unsigned long long msr;
1008 if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1009 return 0;
1011 if (model == 0x37)
1012 rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1013 else
1014 rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1015 }
1017 return 0;
1018 }
1021 /********************
1022 * Topology Probing *
1023 ********************/
1025 /*
1026 * Read a single int from a file.
1027 */
1028 static int __attribute__ ((format(printf,1,2)))
1029 parse_int_file(const char *fmt, ...)
1030 {
1031 va_list args;
1032 char path[PATH_MAX];
1033 FILE *filep;
1034 int len, value;
1036 va_start(args, fmt);
1037 len = vsnprintf(path, sizeof(path), fmt, args);
1038 va_end(args);
1039 if (len < 0 || len >= PATH_MAX) {
1040 ERROR("Turbostat plugin: path truncated: '%s'", path);
1041 return -1;
1042 }
1044 filep = fopen(path, "r");
1045 if (!filep) {
1046 ERROR("Turbostat plugin: Failed to open '%s'", path);
1047 return -1;
1048 }
1049 if (fscanf(filep, "%d", &value) != 1) {
1050 ERROR("Turbostat plugin: Failed to parse number from '%s'", path);
1051 return -1;
1052 }
1053 fclose(filep);
1054 return value;
1055 }
1057 static int
1058 get_threads_on_core(int cpu)
1059 {
1060 char path[80];
1061 FILE *filep;
1062 int sib1, sib2;
1063 int matches;
1064 char character;
1066 ssnprintf(path, sizeof(path), "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
1067 filep = fopen(path, "r");
1068 if (!filep) {
1069 ERROR("Turbostat plugin: Failed to open '%s'", path);
1070 return -1;
1071 }
1072 /*
1073 * file format:
1074 * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
1075 * otherwinse 1 sibling (self).
1076 */
1077 matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
1079 fclose(filep);
1081 if (matches == 3)
1082 return 2;
1083 else
1084 return 1;
1085 }
1087 /*
1088 * run func(cpu) on every cpu in /proc/stat
1089 * return max_cpu number
1090 */
1091 static int __attribute__((warn_unused_result))
1092 for_all_proc_cpus(int (func)(int))
1093 {
1094 FILE *fp;
1095 int cpu_num;
1096 int retval;
1098 fp = fopen("/proc/stat", "r");
1099 if (!fp) {
1100 ERROR("Turbostat plugin: Failed to open /proc/stat");
1101 return -1;
1102 }
1104 retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
1105 if (retval != 0) {
1106 ERROR("Turbostat plugin: Failed to parse /proc/stat");
1107 fclose(fp);
1108 return -1;
1109 }
1111 while (1) {
1112 retval = fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
1113 if (retval != 1)
1114 break;
1116 retval = func(cpu_num);
1117 if (retval) {
1118 fclose(fp);
1119 return(retval);
1120 }
1121 }
1122 fclose(fp);
1123 return 0;
1124 }
1126 /*
1127 * Update the stored topology.max_cpu_id
1128 */
1129 static int
1130 update_max_cpu_id(int cpu)
1131 {
1132 if (topology.max_cpu_id < cpu)
1133 topology.max_cpu_id = cpu;
1134 return 0;
1135 }
1137 static int
1138 mark_cpu_present(int cpu)
1139 {
1140 CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
1141 return 0;
1142 }
1144 static int __attribute__((warn_unused_result))
1145 allocate_cpu_set(cpu_set_t ** set, size_t * size) {
1146 *set = CPU_ALLOC(topology.max_cpu_id + 1);
1147 if (*set == NULL) {
1148 ERROR("Turbostat plugin: Unable to allocate CPU state");
1149 return -1;
1150 }
1151 *size = CPU_ALLOC_SIZE(topology.max_cpu_id + 1);
1152 CPU_ZERO_S(*size, *set);
1153 return 0;
1154 }
1156 /*
1157 * Build a local representation of the cpu distribution
1158 */
1159 static int __attribute__((warn_unused_result))
1160 topology_probe()
1161 {
1162 int i;
1163 int ret;
1164 int max_package_id, max_core_id, max_thread_id;
1165 max_package_id = max_core_id = max_thread_id = 0;
1167 /* Clean topology */
1168 free(topology.cpus);
1169 memset(&topology, 0, sizeof(topology));
1171 ret = for_all_proc_cpus(update_max_cpu_id);
1172 if (ret != 0)
1173 goto err;
1175 topology.cpus = calloc(1, (topology.max_cpu_id + 1) * sizeof(struct cpu_topology));
1176 if (topology.cpus == NULL) {
1177 ERROR("Turbostat plugin: Unable to allocate memory for CPU topology");
1178 return -1;
1179 }
1181 ret = allocate_cpu_set(&cpu_present_set, &cpu_present_setsize);
1182 if (ret != 0)
1183 goto err;
1184 ret = allocate_cpu_set(&cpu_affinity_set, &cpu_affinity_setsize);
1185 if (ret != 0)
1186 goto err;
1187 ret = allocate_cpu_set(&cpu_saved_affinity_set, &cpu_saved_affinity_setsize);
1188 if (ret != 0)
1189 goto err;
1191 ret = for_all_proc_cpus(mark_cpu_present);
1192 if (ret != 0)
1193 goto err;
1195 /*
1196 * For online cpus
1197 * find max_core_id, max_package_id
1198 */
1199 for (i = 0; i <= topology.max_cpu_id; ++i) {
1200 int num_threads;
1201 struct cpu_topology *cpu = &topology.cpus[i];
1203 if (cpu_is_not_present(i)) {
1204 WARNING("Turbostat plugin: cpu%d NOT PRESENT", i);
1205 continue;
1206 }
1208 ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/physical_package_id", i);
1209 if (ret < 0)
1210 goto err;
1211 else
1212 cpu->package_id = ret;
1213 if (cpu->package_id > max_package_id)
1214 max_package_id = cpu->package_id;
1216 ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", i);
1217 if (ret < 0)
1218 goto err;
1219 else
1220 cpu->core_id = ret;
1221 if (cpu->core_id > max_core_id)
1222 max_core_id = cpu->core_id;
1223 ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", i);
1224 if (ret < 0)
1225 goto err;
1226 else if (ret == i)
1227 cpu->first_core_in_package = 1;
1229 ret = get_threads_on_core(i);
1230 if (ret < 0)
1231 goto err;
1232 else
1233 num_threads = ret;
1234 if (num_threads > max_thread_id)
1235 max_thread_id = num_threads;
1236 ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", i);
1237 if (ret < 0)
1238 goto err;
1239 else if (ret == i)
1240 cpu->first_thread_in_core = 1;
1242 DEBUG("Turbostat plugin: cpu %d pkg %d core %d\n",
1243 i, cpu->package_id, cpu->core_id);
1244 }
1245 /* Num is max + 1 (need to count 0) */
1246 topology.num_packages = max_package_id + 1;
1247 topology.num_cores = max_core_id + 1;
1248 topology.num_threads = max_thread_id + 1;
1250 return 0;
1251 err:
1252 free(topology.cpus);
1253 return ret;
1254 }
1257 /************************
1258 * Main alloc/init/free *
1259 ************************/
1261 static int
1262 allocate_counters(struct thread_data **threads, struct core_data **cores, struct pkg_data **packages)
1263 {
1264 int i;
1265 int total_threads, total_cores;
1267 total_threads = topology.num_threads * topology.num_cores * topology.num_packages;
1268 *threads = calloc(total_threads, sizeof(struct thread_data));
1269 if (*threads == NULL)
1270 goto err;
1272 for (i = 0; i < total_threads; ++i)
1273 (*threads)[i].cpu_id = -1;
1275 total_cores = topology.num_cores * topology.num_packages;
1276 *cores = calloc(total_cores, sizeof(struct core_data));
1277 if (*cores == NULL)
1278 goto err_clean_threads;
1280 for (i = 0; i < total_cores; ++i)
1281 (*cores)[i].core_id = -1;
1283 *packages = calloc(topology.num_packages, sizeof(struct pkg_data));
1284 if (*packages == NULL)
1285 goto err_clean_cores;
1287 for (i = 0; i < topology.num_packages; i++)
1288 (*packages)[i].package_id = i;
1290 return 0;
1292 err_clean_cores:
1293 free(*cores);
1294 err_clean_threads:
1295 free(*threads);
1296 err:
1297 ERROR("Turbostat plugin: Failled to allocate memory for counters");
1298 return -1;
1299 }
1301 static void
1302 init_counter(struct thread_data *thread_base, struct core_data *core_base,
1303 struct pkg_data *pkg_base, int cpu_id)
1304 {
1305 struct thread_data *t;
1306 struct core_data *c;
1307 struct pkg_data *p;
1308 struct cpu_topology *cpu = &topology.cpus[cpu_id];
1310 t = GET_THREAD(thread_base, !(cpu->first_thread_in_core), cpu->core_id, cpu->package_id);
1311 c = GET_CORE(core_base, cpu->core_id, cpu->package_id);
1312 p = GET_PKG(pkg_base, cpu->package_id);
1314 t->cpu_id = cpu_id;
1315 if (cpu->first_thread_in_core)
1316 t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1317 if (cpu->first_core_in_package)
1318 t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1320 c->core_id = cpu->core_id;
1321 p->package_id = cpu->package_id;
1322 }
1324 static void
1325 initialize_counters(void)
1326 {
1327 int cpu_id;
1329 for (cpu_id = 0; cpu_id <= topology.max_cpu_id; ++cpu_id) {
1330 if (cpu_is_not_present(cpu_id))
1331 continue;
1332 init_counter(EVEN_COUNTERS, cpu_id);
1333 init_counter(ODD_COUNTERS, cpu_id);
1334 init_counter(DELTA_COUNTERS, cpu_id);
1335 }
1336 }
1340 static void
1341 free_all_buffers(void)
1342 {
1343 allocated = 0;
1344 initialized = 0;
1346 CPU_FREE(cpu_present_set);
1347 cpu_present_set = NULL;
1348 cpu_present_set = 0;
1350 CPU_FREE(cpu_affinity_set);
1351 cpu_affinity_set = NULL;
1352 cpu_affinity_setsize = 0;
1354 CPU_FREE(cpu_saved_affinity_set);
1355 cpu_saved_affinity_set = NULL;
1356 cpu_saved_affinity_setsize = 0;
1358 free(thread_even);
1359 free(core_even);
1360 free(package_even);
1362 thread_even = NULL;
1363 core_even = NULL;
1364 package_even = NULL;
1366 free(thread_odd);
1367 free(core_odd);
1368 free(package_odd);
1370 thread_odd = NULL;
1371 core_odd = NULL;
1372 package_odd = NULL;
1374 free(thread_delta);
1375 free(core_delta);
1376 free(package_delta);
1378 thread_delta = NULL;
1379 core_delta = NULL;
1380 package_delta = NULL;
1381 }
1384 /**********************
1385 * Collectd functions *
1386 **********************/
1388 #define DO_OR_GOTO_ERR(something) \
1389 do { \
1390 ret = (something); \
1391 if (ret < 0) \
1392 goto err; \
1393 } while (0)
1395 static int setup_all_buffers(void)
1396 {
1397 int ret;
1399 DO_OR_GOTO_ERR(topology_probe());
1400 DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1401 DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1402 DO_OR_GOTO_ERR(allocate_counters(&thread_delta, &core_delta, &package_delta));
1403 initialize_counters();
1404 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1405 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, ODD_COUNTERS));
1407 allocated = 1;
1408 return 0;
1409 err:
1410 free_all_buffers();
1411 return ret;
1412 }
1414 static int
1415 turbostat_read(void)
1416 {
1417 int ret;
1419 if (!allocated) {
1420 if ((ret = setup_all_buffers()) < 0)
1421 return ret;
1422 }
1424 if (for_all_proc_cpus(cpu_is_not_present)) {
1425 free_all_buffers();
1426 if ((ret = setup_all_buffers()) < 0)
1427 return ret;
1428 if (for_all_proc_cpus(cpu_is_not_present)) {
1429 ERROR("Turbostat plugin: CPU appeared just after "
1430 "initialization");
1431 return -1;
1432 }
1433 }
1435 /* Saving the scheduling affinity, as it will be modified by get_counters */
1436 if (sched_getaffinity(0, cpu_saved_affinity_setsize, cpu_saved_affinity_set) != 0) {
1437 ERROR("Turbostat plugin: Unable to save the CPU affinity");
1438 return -1;
1439 }
1441 if (!initialized) {
1442 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1443 goto out;
1444 time_even = cdtime();
1445 is_even = 1;
1446 initialized = 1;
1447 ret = 0;
1448 goto out;
1449 }
1451 if (is_even) {
1452 if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
1453 goto out;
1454 time_odd = cdtime();
1455 is_even = 0;
1456 time_delta = time_odd - time_even;
1457 if ((ret = for_all_cpus_delta(ODD_COUNTERS, EVEN_COUNTERS)) < 0)
1458 goto out;
1459 if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1460 goto out;
1461 } else {
1462 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1463 goto out;
1464 time_even = cdtime();
1465 is_even = 1;
1466 time_delta = time_even - time_odd;
1467 if ((ret = for_all_cpus_delta(EVEN_COUNTERS, ODD_COUNTERS)) < 0)
1468 goto out;
1469 if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1470 goto out;
1471 }
1472 ret = 0;
1473 out:
1474 /*
1475 * Let's restore the affinity
1476 * This might fail if the number of CPU changed, but we can't do anything in that case..
1477 */
1478 (void)sched_setaffinity(0, cpu_saved_affinity_setsize, cpu_saved_affinity_set);
1479 return ret;
1480 }
1482 static int
1483 check_permissions(void)
1484 {
1485 struct __user_cap_header_struct cap_header_data;
1486 cap_user_header_t cap_header = &cap_header_data;
1487 struct __user_cap_data_struct cap_data_data;
1488 cap_user_data_t cap_data = &cap_data_data;
1489 int ret = 0;
1491 if (getuid() == 0) {
1492 /* We have everything we need */
1493 return 0;
1494 }
1496 /* check for CAP_SYS_RAWIO */
1497 cap_header->pid = getpid();
1498 cap_header->version = _LINUX_CAPABILITY_VERSION;
1499 if (capget(cap_header, cap_data) < 0) {
1500 ERROR("Turbostat plugin: capget failed");
1501 return -1;
1502 }
1504 if ((cap_data->effective & (1 << CAP_SYS_RAWIO)) == 0) {
1505 WARNING("Turbostat plugin: Collectd doesn't have the "
1506 "CAP_SYS_RAWIO capability. If you don't want to run "
1507 "collectd as root, try running \"setcap "
1508 "cap_sys_rawio=ep\" on collectd binary");
1509 ret = -1;
1510 }
1512 if (euidaccess("/dev/cpu/0/msr", R_OK)) {
1513 WARNING("Turbostat plugin: Collectd cannot open"
1514 "/dev/cpu/0/msr. If you don't want to run collectd as "
1515 "root, you need to change the ownership (chown) and "
1516 "permissions on /dev/cpu/*/msr to allow such access");
1517 ret = -1;
1518 }
1520 if (ret != 0)
1521 ERROR("Turbostat plugin: Initialization failed: this plugin "
1522 "requires collectd to either to run as root or give "
1523 "collectd a special capability (CAP_SYS_RAWIO) and read "
1524 "access to /dev/cpu/*/msr (see previous warnings)");
1525 return ret;
1526 }
1528 static int
1529 turbostat_init(void)
1530 {
1531 struct stat sb;
1532 int ret;
1534 if (stat("/dev/cpu/0/msr", &sb)) {
1535 ERROR("Turbostat plugin: Initialization failed: /dev/cpu/0/msr"
1536 " does not exist while the CPU supports MSR. You may be "
1537 "missing the corresponding kernel module, please try '# "
1538 "modprobe msr'");
1539 return -1;
1540 }
1542 DO_OR_GOTO_ERR(check_permissions());
1544 DO_OR_GOTO_ERR(probe_cpu());
1546 DO_OR_GOTO_ERR(setup_all_buffers());
1548 plugin_register_read(PLUGIN_NAME, turbostat_read);
1550 return 0;
1551 err:
1552 free_all_buffers();
1553 return ret;
1554 }
1556 static int
1557 turbostat_config(const char *key, const char *value)
1558 {
1559 long unsigned int tmp_val;
1560 char *end;
1562 if (strcasecmp("CoreCstates", key) == 0) {
1563 tmp_val = strtoul(value, &end, 0);
1564 if (*end != '\0' || tmp_val > UINT_MAX) {
1565 ERROR("Turbostat plugin: Invalid CoreCstates '%s'",
1566 value);
1567 return -1;
1568 }
1569 config_core_cstate = (unsigned int) tmp_val;
1570 apply_config_core_cstate = 1;
1571 } else if (strcasecmp("PackageCstates", key) == 0) {
1572 tmp_val = strtoul(value, &end, 0);
1573 if (*end != '\0' || tmp_val > UINT_MAX) {
1574 ERROR("Turbostat plugin: Invalid PackageCstates '%s'",
1575 value);
1576 return -1;
1577 }
1578 config_pkg_cstate = (unsigned int) tmp_val;
1579 apply_config_pkg_cstate = 1;
1580 } else if (strcasecmp("SystemManagementInterrupt", key) == 0) {
1581 config_smi = IS_TRUE(value);
1582 apply_config_smi = 1;
1583 } else if (strcasecmp("DigitalTemperatureSensor", key) == 0) {
1584 config_dts = IS_TRUE(value);
1585 apply_config_dts = 1;
1586 } else if (strcasecmp("PackageThermalManagement", key) == 0) {
1587 config_ptm = IS_TRUE(value);
1588 apply_config_ptm = 1;
1589 } else if (strcasecmp("RunningAveragePowerLimit", key) == 0) {
1590 tmp_val = strtoul(value, &end, 0);
1591 if (*end != '\0' || tmp_val > UINT_MAX) {
1592 ERROR("Turbostat plugin: Invalid RunningAveragePowerLimit '%s'",
1593 value);
1594 return -1;
1595 }
1596 config_rapl = (unsigned int) tmp_val;
1597 apply_config_rapl = 1;
1598 } else if (strcasecmp("TCCActivationTemp", key) == 0) {
1599 tmp_val = strtoul(value, &end, 0);
1600 if (*end != '\0' || tmp_val > UINT_MAX) {
1601 ERROR("Turbostat plugin: Invalid TCCActivationTemp '%s'",
1602 value);
1603 return -1;
1604 }
1605 tcc_activation_temp = (unsigned int) tmp_val;
1606 } else {
1607 ERROR("Turbostat plugin: Invalid configuration option '%s'",
1608 key);
1609 return -1;
1610 }
1611 return 0;
1612 }
1614 void module_register(void)
1615 {
1616 plugin_register_init(PLUGIN_NAME, turbostat_init);
1617 plugin_register_config(PLUGIN_NAME, turbostat_config, config_keys, config_keys_num);
1618 }