turbostat: import msr-index header from linux
[collectd.git] / src / turbostat.c
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  */
26
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
37
38 #include "collectd.h"
39
40 #include "common.h"
41 #include "plugin.h"
42 #include "utils_time.h"
43
44 #include "msr-index.h"
45 #include <cpuid.h>
46 #ifdef HAVE_SYS_CAPABILITY_H
47 #include <sys/capability.h>
48 #endif /* HAVE_SYS_CAPABILITY_H */
49
50 #define PLUGIN_NAME "turbostat"
51
52 /*
53  * This tool uses the Model-Specific Registers (MSRs) present on Intel
54  * processors.
55  * The general description each of these registers, depending on the
56  * architecture,
57  * can be found in the IntelĀ® 64 and IA-32 Architectures Software Developer
58  * Manual,
59  * Volume 3 Chapter 35.
60  */
61
62 /*
63  * If set, aperf_mperf_unstable disables a/mperf based stats.
64  * This includes: C0 & C1 states, frequency
65  *
66  * This value is automatically set if mperf or aperf go backward
67  */
68 static _Bool aperf_mperf_unstable;
69
70 /*
71  * If set, use kernel logical core numbering for all "per core" metrics.
72  */
73 static _Bool config_lcn;
74
75 /*
76  * Bitmask of the list of core C states supported by the processor.
77  * Currently supported C-states (by this plugin): 3, 6, 7
78  */
79 static unsigned int do_core_cstate;
80 static unsigned int config_core_cstate;
81 static _Bool apply_config_core_cstate;
82
83 /*
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
86  */
87 static unsigned int do_pkg_cstate;
88 static unsigned int config_pkg_cstate;
89 static _Bool apply_config_pkg_cstate;
90
91 /*
92  * Boolean indicating if the processor supports 'I/O System-Management Interrupt
93  * counter'
94  */
95 static _Bool do_smi;
96 static _Bool config_smi;
97 static _Bool apply_config_smi;
98
99 /*
100  * Boolean indicating if the processor supports 'Digital temperature sensor'
101  * This feature enables the monitoring of the temperature of each core
102  *
103  * This feature has two limitations:
104  *  - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature
105  * might be wrong
106  *  - Temperatures above the tcc_activation_temp are not recorded
107  */
108 static _Bool do_dts;
109 static _Bool config_dts;
110 static _Bool apply_config_dts;
111
112 /*
113  * Boolean indicating if the processor supports 'Package thermal management'
114  * This feature allows the monitoring of the temperature of each package
115  *
116  * This feature has two limitations:
117  *  - if MSR_IA32_TEMPERATURE_TARGET is not supported, the absolute temperature
118  * might be wrong
119  *  - Temperatures above the tcc_activation_temp are not recorded
120  */
121 static _Bool do_ptm;
122 static _Bool config_ptm;
123 static _Bool apply_config_ptm;
124
125 /*
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.
129  */
130 static unsigned int tcc_activation_temp;
131
132 static unsigned int do_rapl;
133 static unsigned int config_rapl;
134 static _Bool apply_config_rapl;
135 static double rapl_energy_units;
136
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 */
147
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
153
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;
157
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;
169
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;
177
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;
194
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;
199
200 static _Bool allocated = 0;
201 static _Bool initialized = 0;
202
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)
209
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;
215 };
216
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;
223 } topology;
224
225 static cdtime_t time_even, time_odd, time_delta;
226
227 static const char *config_keys[] = {
228     "CoreCstates",
229     "PackageCstates",
230     "SystemManagementInterrupt",
231     "DigitalTemperatureSensor",
232     "PackageThermalManagement",
233     "TCCActivationTemp",
234     "RunningAveragePowerLimit",
235     "LogicalCoreNames",
236 };
237 static const int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
238
239 /*****************************
240  *  MSR Manipulation helpers *
241  *****************************/
242
243 /*
244  * Open a MSR device for reading
245  * Can change the scheduling affinity of the current process if multiple_read is
246  * 1
247  */
248 static int __attribute__((warn_unused_result))
249 open_msr(unsigned int cpu, _Bool multiple_read) {
250   char pathname[32];
251   int fd;
252
253   /*
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
256    *
257    * If we are not yet initialized (cpu_affinity_setsize = 0),
258    * we need to skip this optimisation.
259    */
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);
265       return -1;
266     }
267   }
268
269   ssnprintf(pathname, sizeof(pathname), "/dev/cpu/%d/msr", cpu);
270   fd = open(pathname, O_RDONLY);
271   if (fd < 0) {
272     ERROR("turbostat plugin: failed to open %s", pathname);
273     return -1;
274   }
275   return fd;
276 }
277
278 /*
279  * Read a single MSR from an open file descriptor
280  */
281 static int __attribute__((warn_unused_result))
282 read_msr(int fd, off_t offset, unsigned long long *msr) {
283   ssize_t retval;
284
285   retval = pread(fd, msr, sizeof *msr, offset);
286
287   if (retval != sizeof *msr) {
288     ERROR("turbostat plugin: MSR offset 0x%llx read failed",
289           (unsigned long long)offset);
290     return -1;
291   }
292   return 0;
293 }
294
295 /*
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.
298  */
299 static ssize_t __attribute__((warn_unused_result))
300 get_msr(unsigned int cpu, off_t offset, unsigned long long *msr) {
301   ssize_t retval;
302   int fd;
303
304   fd = open_msr(cpu, 0);
305   if (fd < 0)
306     return fd;
307   retval = read_msr(fd, offset, msr);
308   close(fd);
309   return retval;
310 }
311
312 /********************************
313  * Raw data acquisition (1 CPU) *
314  ********************************/
315
316 /*
317  * Read every data avalaible for a single CPU
318  *
319  * Core data is shared for all threads in one core: extracted only for the first
320  * thread
321  * Package data is shared for all core in one package: extracted only for the
322  * first thread of the first core
323  *
324  * Side effect: migrates to the targeted CPU
325  */
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;
330   int msr_fd;
331   int retval = 0;
332
333   msr_fd = open_msr(cpu, 1);
334   if (msr_fd < 0)
335     return msr_fd;
336
337 #define READ_MSR(msr, dst)                                                     \
338   do {                                                                         \
339     if (read_msr(msr_fd, msr, dst)) {                                          \
340       ERROR("turbostat plugin: Unable to read " #msr);                         \
341       retval = -1;                                                             \
342       goto out;                                                                \
343     }                                                                          \
344   } while (0)
345
346   READ_MSR(MSR_IA32_TSC, &t->tsc);
347
348   READ_MSR(MSR_IA32_APERF, &t->aperf);
349   READ_MSR(MSR_IA32_MPERF, &t->mperf);
350
351   if (do_smi) {
352     READ_MSR(MSR_SMI_COUNT, &msr);
353     t->smi_count = msr & 0xFFFFFFFF;
354   }
355
356   /* collect core counters only for 1st thread in core */
357   if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE)) {
358     retval = 0;
359     goto out;
360   }
361
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);
368
369   if (do_dts) {
370     READ_MSR(MSR_IA32_THERM_STATUS, &msr);
371     c->core_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
372   }
373
374   /* collect package counters only for 1st core in package */
375   if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)) {
376     retval = 0;
377     goto out;
378   }
379
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);
394
395   if (do_rapl & RAPL_PKG) {
396     READ_MSR(MSR_PKG_ENERGY_STATUS, &msr);
397     p->energy_pkg = msr & 0xFFFFFFFF;
398   }
399   if (do_rapl & RAPL_CORES) {
400     READ_MSR(MSR_PP0_ENERGY_STATUS, &msr);
401     p->energy_cores = msr & 0xFFFFFFFF;
402   }
403   if (do_rapl & RAPL_DRAM) {
404     READ_MSR(MSR_DRAM_ENERGY_STATUS, &msr);
405     p->energy_dram = msr & 0xFFFFFFFF;
406   }
407   if (do_rapl & RAPL_GFX) {
408     READ_MSR(MSR_PP1_ENERGY_STATUS, &msr);
409     p->energy_gfx = msr & 0xFFFFFFFF;
410   }
411   if (do_ptm) {
412     READ_MSR(MSR_IA32_PACKAGE_THERM_STATUS, &msr);
413     p->pkg_temp_c = p->tcc_activation_temp - ((msr >> 16) & 0x7F);
414   }
415
416 out:
417   close(msr_fd);
418   return retval;
419 }
420
421 /**********************************
422  * Evaluating the changes (1 CPU) *
423  **********************************/
424
425 /*
426  * Extract the evolution old->new in delta at a package level
427  * (some are not new-delta, e.g. temperature)
428  */
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;
440
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;
445 }
446
447 /*
448  * Extract the evolution old->new in delta at a core level
449  * (some are not new-delta, e.g. temperature)
450  */
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;
458 }
459
460 /*
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)
463  */
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;
468
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'");
475     return -1;
476   }
477
478   delta->c1 = new->c1 - old->c1;
479
480   if ((new->aperf > old->aperf) && (new->mperf > old->mperf)) {
481     delta->aperf = new->aperf - old->aperf;
482     delta->mperf = new->mperf - old->mperf;
483   } else {
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.");
489
490       aperf_mperf_unstable = 1;
491     }
492   }
493
494   /*
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.
498    */
499   if ((delta->mperf + cdelta->c3 + cdelta->c6 + cdelta->c7) > delta->tsc)
500     delta->c1 = 0;
501   else {
502     /* normal case, derive c1 */
503     delta->c1 =
504         delta->tsc - delta->mperf - cdelta->c3 - cdelta->c6 - cdelta->c7;
505   }
506
507   if (delta->mperf == 0) {
508     WARNING("turbostat plugin: cpu%d MPERF 0!", old->cpu_id);
509     delta->mperf = 1; /* divide by 0 protection */
510   }
511
512   if (do_smi)
513     delta->smi_count = new->smi_count - old->smi_count;
514
515   return 0;
516 }
517
518 /**********************************
519  * Submitting the results (1 CPU) *
520  **********************************/
521
522 /*
523  * Submit one gauge value
524  */
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;
528
529   vl.values = &(value_t){.gauge = value};
530   vl.values_len = 1;
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));
537
538   plugin_dispatch_values(&vl);
539 }
540
541 /*
542  * Submit every data for a single CPU
543  *
544  * Core data is shared for all threads in one core: submitted only for the first
545  * thread
546  * Package data is shared for all core in one package: submitted only for the
547  * first thread of the first core
548  */
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;
553
554   interval_float = CDTIME_T_TO_DOUBLE(time_delta);
555
556   DEBUG("turbostat plugin: submit stats for cpu: %d, core: %d, pkg: %d",
557         t->cpu_id, c->core_id, p->package_id);
558
559   ssnprintf(name, sizeof(name), "cpu%02d", t->cpu_id);
560
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);
565
566   turbostat_submit(name, "frequency", "average",
567                    1.0 / 1000000 * t->aperf / interval_float);
568
569   if ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc)))
570     turbostat_submit(name, "frequency", "busy", 1.0 * t->tsc / 1000000 *
571                                                     t->aperf / t->mperf /
572                                                     interval_float);
573
574   /* Sanity check (should stay stable) */
575   turbostat_submit(name, "gauge", "TSC",
576                    1.0 * t->tsc / 1000000 / interval_float);
577
578   /* SMI */
579   if (do_smi)
580     turbostat_submit(name, "count", NULL, t->smi_count);
581
582   /* submit per-core data only for 1st thread in core */
583   if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
584     goto done;
585
586   /* If not using logical core numbering, set core id */
587   if (!config_lcn) {
588     ssnprintf(name, sizeof(name), "core%02d", c->core_id);
589   }
590
591   if (do_core_cstate & (1 << 3))
592     turbostat_submit(name, "percent", "c3", 100.0 * c->c3 / t->tsc);
593   if (do_core_cstate & (1 << 6))
594     turbostat_submit(name, "percent", "c6", 100.0 * c->c6 / t->tsc);
595   if (do_core_cstate & (1 << 7))
596     turbostat_submit(name, "percent", "c7", 100.0 * c->c7 / t->tsc);
597
598   if (do_dts)
599     turbostat_submit(name, "temperature", NULL, c->core_temp_c);
600
601   /* submit per-package data only for 1st core in package */
602   if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
603     goto done;
604
605   ssnprintf(name, sizeof(name), "pkg%02d", p->package_id);
606
607   if (do_ptm)
608     turbostat_submit(name, "temperature", NULL, p->pkg_temp_c);
609
610   if (do_pkg_cstate & (1 << 2))
611     turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2 / t->tsc);
612   if (do_pkg_cstate & (1 << 3))
613     turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3 / t->tsc);
614   if (do_pkg_cstate & (1 << 6))
615     turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6 / t->tsc);
616   if (do_pkg_cstate & (1 << 7))
617     turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7 / t->tsc);
618   if (do_pkg_cstate & (1 << 8))
619     turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8 / t->tsc);
620   if (do_pkg_cstate & (1 << 9))
621     turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9 / t->tsc);
622   if (do_pkg_cstate & (1 << 10))
623     turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10 / t->tsc);
624
625   if (do_rapl) {
626     if (do_rapl & RAPL_PKG)
627       turbostat_submit(name, "power", "pkg",
628                        p->energy_pkg * rapl_energy_units / interval_float);
629     if (do_rapl & RAPL_CORES)
630       turbostat_submit(name, "power", "cores",
631                        p->energy_cores * rapl_energy_units / interval_float);
632     if (do_rapl & RAPL_GFX)
633       turbostat_submit(name, "power", "GFX",
634                        p->energy_gfx * rapl_energy_units / interval_float);
635     if (do_rapl & RAPL_DRAM)
636       turbostat_submit(name, "power", "DRAM",
637                        p->energy_dram * rapl_energy_units / interval_float);
638   }
639 done:
640   return 0;
641 }
642
643 /**********************************
644  * Looping function over all CPUs *
645  **********************************/
646
647 /*
648  * Check if a given cpu id is in our compiled list of existing CPUs
649  */
650 static int cpu_is_not_present(unsigned int cpu) {
651   return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
652 }
653
654 /*
655  * Loop on all CPUs in topological order
656  *
657  * Skip non-present cpus
658  * Return the error code at the first error or 0
659  */
660 static int __attribute__((warn_unused_result))
661 for_all_cpus(int(func)(struct thread_data *, struct core_data *,
662                        struct pkg_data *),
663              struct thread_data *thread_base, struct core_data *core_base,
664              struct pkg_data *pkg_base) {
665   int retval;
666
667   for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
668     for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
669       for (unsigned int thread_no = 0; thread_no < topology.num_threads;
670            ++thread_no) {
671         struct thread_data *t;
672         struct core_data *c;
673         struct pkg_data *p;
674
675         t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
676
677         if (cpu_is_not_present(t->cpu_id))
678           continue;
679
680         c = GET_CORE(core_base, core_no, pkg_no);
681         p = GET_PKG(pkg_base, pkg_no);
682
683         retval = func(t, c, p);
684         if (retval)
685           return retval;
686       }
687     }
688   }
689   return 0;
690 }
691
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
699  * thread
700  * Package data is shared for all core in one package: extracted only for the
701  * first thread of the first core
702  */
703 static int __attribute__((warn_unused_result))
704 for_all_cpus_delta(const struct thread_data *thread_new_base,
705                    const struct core_data *core_new_base,
706                    const struct pkg_data *pkg_new_base,
707                    const struct thread_data *thread_old_base,
708                    const struct core_data *core_old_base,
709                    const struct pkg_data *pkg_old_base) {
710   int retval;
711
712   for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
713     for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
714       for (unsigned int thread_no = 0; thread_no < topology.num_threads;
715            ++thread_no) {
716         struct thread_data *t_delta;
717         const struct thread_data *t_old, *t_new;
718         struct core_data *c_delta;
719
720         /* Get correct pointers for threads */
721         t_delta = GET_THREAD(thread_delta, thread_no, core_no, pkg_no);
722         t_new = GET_THREAD(thread_new_base, thread_no, core_no, pkg_no);
723         t_old = GET_THREAD(thread_old_base, thread_no, core_no, pkg_no);
724
725         /* Skip threads that disappeared */
726         if (cpu_is_not_present(t_delta->cpu_id))
727           continue;
728
729         /* c_delta is always required for delta_thread */
730         c_delta = GET_CORE(core_delta, core_no, pkg_no);
731
732         /* calculate core delta only for 1st thread in core */
733         if (t_new->flags & CPU_IS_FIRST_THREAD_IN_CORE) {
734           const struct core_data *c_old, *c_new;
735
736           c_new = GET_CORE(core_new_base, core_no, pkg_no);
737           c_old = GET_CORE(core_old_base, core_no, pkg_no);
738
739           delta_core(c_delta, c_new, c_old);
740         }
741
742         /* Always calculate thread delta */
743         retval = delta_thread(t_delta, t_new, t_old, c_delta);
744         if (retval)
745           return retval;
746
747         /* calculate package delta only for 1st core in package */
748         if (t_new->flags & CPU_IS_FIRST_CORE_IN_PACKAGE) {
749           struct pkg_data *p_delta;
750           const struct pkg_data *p_old, *p_new;
751
752           p_delta = GET_PKG(package_delta, pkg_no);
753           p_new = GET_PKG(pkg_new_base, pkg_no);
754           p_old = GET_PKG(pkg_old_base, pkg_no);
755
756           delta_package(p_delta, p_new, p_old);
757         }
758       }
759     }
760   }
761   return 0;
762 }
763
764 /***************
765  * CPU Probing *
766  ***************/
767
768 /*
769  * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
770  * the Thermal Control Circuit (TCC) activates.
771  * This is usually equal to tjMax.
772  *
773  * Older processors do not have this MSR, so there we guess,
774  * but also allow conficuration over-ride with "TCCActivationTemp".
775  *
776  * Several MSR temperature values are in units of degrees-C
777  * below this value, including the Digital Thermal Sensor (DTS),
778  * Package Thermal Management Sensor (PTM), and thermal event thresholds.
779  */
780 static int __attribute__((warn_unused_result))
781 set_temperature_target(struct thread_data *t, struct core_data *c,
782                        struct pkg_data *p) {
783   unsigned long long msr;
784   unsigned int target_c_local;
785
786   /* tcc_activation_temp is used only for dts or ptm */
787   if (!(do_dts || do_ptm))
788     return 0;
789
790   /* this is a per-package concept */
791   if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) ||
792       !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
793     return 0;
794
795   if (tcc_activation_temp != 0) {
796     p->tcc_activation_temp = tcc_activation_temp;
797     return 0;
798   }
799
800   if (get_msr(t->cpu_id, MSR_IA32_TEMPERATURE_TARGET, &msr))
801     goto guess;
802
803   target_c_local = (msr >> 16) & 0xFF;
804
805   if (!target_c_local)
806     goto guess;
807
808   p->tcc_activation_temp = target_c_local;
809
810   return 0;
811
812 guess:
813   p->tcc_activation_temp = TJMAX_DEFAULT;
814   WARNING("turbostat plugin: cpu%d: Guessing tjMax %d C,"
815           " Please use TCCActivationTemp to specify it.",
816           t->cpu_id, p->tcc_activation_temp);
817
818   return 0;
819 }
820
821 /*
822  * Identify the functionality of the CPU
823  */
824 static int __attribute__((warn_unused_result)) probe_cpu(void) {
825   unsigned int eax, ebx, ecx, edx, max_level;
826   unsigned int fms, family, model;
827
828   /* CPUID(0):
829    * - EAX: Maximum Input Value for Basic CPUID Information
830    * - EBX: "Genu" (0x756e6547)
831    * - EDX: "ineI" (0x49656e69)
832    * - ECX: "ntel" (0x6c65746e)
833    */
834   max_level = ebx = ecx = edx = 0;
835   __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
836   if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
837     ERROR("turbostat plugin: Unsupported CPU (not Intel)");
838     return -1;
839   }
840
841   /* CPUID(1):
842    * - EAX: Version Information: Type, Family, Model, and Stepping ID
843    *  + 4-7:   Model ID
844    *  + 8-11:  Family ID
845    *  + 12-13: Processor type
846    *  + 16-19: Extended Model ID
847    *  + 20-27: Extended Family ID
848    * - EDX: Feature Information:
849    *  + 5: Support for MSR read/write operations
850    */
851   fms = ebx = ecx = edx = 0;
852   __get_cpuid(1, &fms, &ebx, &ecx, &edx);
853   family = (fms >> 8) & 0xf;
854   model = (fms >> 4) & 0xf;
855   if (family == 0xf)
856     family += (fms >> 20) & 0xf;
857   if (family == 6 || family == 0xf)
858     model += ((fms >> 16) & 0xf) << 4;
859   if (!(edx & (1 << 5))) {
860     ERROR("turbostat plugin: Unsupported CPU (no MSR support)");
861     return -1;
862   }
863
864   /*
865    * CPUID(6):
866    * - EAX:
867    *  + 0: Digital temperature sensor is supported if set
868    *  + 6: Package thermal management is supported if set
869    * - ECX:
870    *  + 0: Hardware Coordination Feedback Capability (Presence of IA32_MPERF and
871    * IA32_APERF).
872    *  + 3: The processor supports performance-energy bias preference if set.
873    *       It also implies the presence of a new architectural MSR called
874    * IA32_ENERGY_PERF_BIAS
875    *
876    * This check is valid for both Intel and AMD
877    */
878   eax = ebx = ecx = edx = 0;
879   __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
880   do_dts = eax & (1 << 0);
881   do_ptm = eax & (1 << 6);
882   if (!(ecx & (1 << 0))) {
883     ERROR("turbostat plugin: Unsupported CPU (No APERF)");
884     return -1;
885   }
886
887   /*
888    * Enable or disable C states depending on the model and family
889    */
890   if (family == 6) {
891     switch (model) {
892     /* Atom (partial) */
893     case 0x27:
894       do_smi = 0;
895       do_core_cstate = 0;
896       do_pkg_cstate = (1 << 2) | (1 << 4) | (1 << 6);
897       break;
898     /* Silvermont */
899     case 0x37: /* BYT */
900     case 0x4D: /* AVN */
901       do_smi = 1;
902       do_core_cstate = (1 << 1) | (1 << 6);
903       do_pkg_cstate = (1 << 6);
904       break;
905     /* Nehalem */
906     case 0x1A: /* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
907     case 0x1E: /* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper
908                   Forest */
909     case 0x1F: /* Core i7 and i5 Processor - Nehalem */
910     case 0x2E: /* Nehalem-EX Xeon - Beckton */
911       do_smi = 1;
912       do_core_cstate = (1 << 3) | (1 << 6);
913       do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
914       break;
915     /* Westmere */
916     case 0x25: /* Westmere Client - Clarkdale, Arrandale */
917     case 0x2C: /* Westmere EP - Gulftown */
918     case 0x2F: /* Westmere-EX Xeon - Eagleton */
919       do_smi = 1;
920       do_core_cstate = (1 << 3) | (1 << 6);
921       do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
922       break;
923     /* Sandy Bridge */
924     case 0x2A: /* SNB */
925     case 0x2D: /* SNB 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     /* Ivy Bridge */
931     case 0x3A: /* IVB */
932     case 0x3E: /* IVB Xeon */
933       do_smi = 1;
934       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
935       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
936       break;
937     /* Haswell Bridge */
938     case 0x3C: /* HSW */
939     case 0x3F: /* HSW */
940     case 0x46: /* HSW */
941       do_smi = 1;
942       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
943       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
944       break;
945     case 0x45: /* HSW */
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) | (1 << 8) |
949                       (1 << 9) | (1 << 10);
950       break;
951     /* Broadwel */
952     case 0x4F: /* BDW */
953     case 0x56: /* BDX-DE */
954       do_smi = 1;
955       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
956       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
957       break;
958     case 0x3D: /* BDW */
959       do_smi = 1;
960       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
961       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) |
962                       (1 << 9) | (1 << 10);
963       break;
964     default:
965       do_smi = 0;
966       do_core_cstate = 0;
967       do_pkg_cstate = 0;
968       break;
969     }
970     switch (model) {
971     case 0x2A: /* SNB */
972     case 0x3A: /* IVB */
973     case 0x3C: /* HSW */
974     case 0x45: /* HSW */
975     case 0x46: /* HSW */
976     case 0x3D: /* BDW */
977       do_rapl = RAPL_PKG | RAPL_CORES | RAPL_GFX;
978       break;
979     case 0x3F: /* HSX */
980     case 0x4F: /* BDX */
981     case 0x56: /* BDX-DE */
982       do_rapl = RAPL_PKG | RAPL_DRAM;
983       break;
984     case 0x2D: /* SNB Xeon */
985     case 0x3E: /* IVB Xeon */
986       do_rapl = RAPL_PKG | RAPL_CORES | RAPL_DRAM;
987       break;
988     case 0x37: /* BYT */
989     case 0x4D: /* AVN */
990       do_rapl = RAPL_PKG | RAPL_CORES;
991       break;
992     default:
993       do_rapl = 0;
994     }
995   } else {
996     ERROR("turbostat plugin: Unsupported CPU (family: %#x, "
997           "model: %#x)",
998           family, model);
999     return -1;
1000   }
1001
1002   /* Override detected values with configuration */
1003   if (apply_config_core_cstate)
1004     do_core_cstate = config_core_cstate;
1005   if (apply_config_pkg_cstate)
1006     do_pkg_cstate = config_pkg_cstate;
1007   if (apply_config_smi)
1008     do_smi = config_smi;
1009   if (apply_config_dts)
1010     do_dts = config_dts;
1011   if (apply_config_ptm)
1012     do_ptm = config_ptm;
1013   if (apply_config_rapl)
1014     do_rapl = config_rapl;
1015
1016   if (do_rapl) {
1017     unsigned long long msr;
1018     if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1019       return 0;
1020
1021     if (model == 0x37)
1022       rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1023     else
1024       rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1025   }
1026
1027   return 0;
1028 }
1029
1030 /********************
1031  * Topology Probing *
1032  ********************/
1033
1034 /*
1035  * Read a single int from a file.
1036  */
1037 static int __attribute__((format(printf, 1, 2)))
1038 parse_int_file(const char *fmt, ...) {
1039   va_list args;
1040   char path[PATH_MAX];
1041   int len;
1042
1043   va_start(args, fmt);
1044   len = vsnprintf(path, sizeof(path), fmt, args);
1045   va_end(args);
1046   if (len < 0 || len >= PATH_MAX) {
1047     ERROR("turbostat plugin: path truncated: '%s'", path);
1048     return -1;
1049   }
1050
1051   value_t v;
1052   if (parse_value_file(path, &v, DS_TYPE_DERIVE) != 0) {
1053     ERROR("turbostat plugin: Parsing \"%s\" failed.", path);
1054     return -1;
1055   }
1056
1057   return (int)v.derive;
1058 }
1059
1060 static int get_threads_on_core(unsigned int cpu) {
1061   char path[80];
1062   FILE *filep;
1063   int sib1, sib2;
1064   int matches;
1065   char character;
1066
1067   ssnprintf(path, sizeof(path),
1068             "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
1069   filep = fopen(path, "r");
1070   if (!filep) {
1071     ERROR("turbostat plugin: Failed to open '%s'", path);
1072     return -1;
1073   }
1074   /*
1075    * file format:
1076    * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
1077    * otherwinse 1 sibling (self).
1078    */
1079   matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
1080
1081   fclose(filep);
1082
1083   if (matches == 3)
1084     return 2;
1085   else
1086     return 1;
1087 }
1088
1089 /*
1090  * run func(cpu) on every cpu in /proc/stat
1091  * return max_cpu number
1092  */
1093 static int __attribute__((warn_unused_result))
1094 for_all_proc_cpus(int(func)(unsigned int)) {
1095   FILE *fp;
1096   unsigned int cpu_num;
1097   int retval;
1098
1099   fp = fopen("/proc/stat", "r");
1100   if (!fp) {
1101     ERROR("turbostat plugin: Failed to open /proc/stat");
1102     return -1;
1103   }
1104
1105   retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
1106   if (retval != 0) {
1107     ERROR("turbostat plugin: Failed to parse /proc/stat");
1108     fclose(fp);
1109     return -1;
1110   }
1111
1112   while (1) {
1113     retval =
1114         fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
1115     if (retval != 1)
1116       break;
1117
1118     retval = func(cpu_num);
1119     if (retval) {
1120       fclose(fp);
1121       return (retval);
1122     }
1123   }
1124   fclose(fp);
1125   return 0;
1126 }
1127
1128 /*
1129  * Update the stored topology.max_cpu_id
1130  */
1131 static int update_max_cpu_id(unsigned int cpu) {
1132   if (topology.max_cpu_id < cpu)
1133     topology.max_cpu_id = cpu;
1134   return 0;
1135 }
1136
1137 static int mark_cpu_present(unsigned int cpu) {
1138   CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
1139   return 0;
1140 }
1141
1142 static int __attribute__((warn_unused_result))
1143 allocate_cpu_set(cpu_set_t **set, size_t *size) {
1144   *set = CPU_ALLOC(topology.max_cpu_id + 1);
1145   if (*set == NULL) {
1146     ERROR("turbostat plugin: Unable to allocate CPU state");
1147     return -1;
1148   }
1149   *size = CPU_ALLOC_SIZE(topology.max_cpu_id + 1);
1150   CPU_ZERO_S(*size, *set);
1151   return 0;
1152 }
1153
1154 /*
1155  * Build a local representation of the cpu distribution
1156  */
1157 static int __attribute__((warn_unused_result)) topology_probe(void) {
1158   int ret;
1159   unsigned int max_package_id, max_core_id, max_threads;
1160   max_package_id = max_core_id = max_threads = 0;
1161
1162   /* Clean topology */
1163   free(topology.cpus);
1164   memset(&topology, 0, sizeof(topology));
1165
1166   ret = for_all_proc_cpus(update_max_cpu_id);
1167   if (ret != 0)
1168     goto err;
1169
1170   topology.cpus =
1171       calloc(1, (topology.max_cpu_id + 1) * sizeof(struct cpu_topology));
1172   if (topology.cpus == NULL) {
1173     ERROR("turbostat plugin: Unable to allocate memory for CPU topology");
1174     return -1;
1175   }
1176
1177   ret = allocate_cpu_set(&cpu_present_set, &cpu_present_setsize);
1178   if (ret != 0)
1179     goto err;
1180   ret = allocate_cpu_set(&cpu_affinity_set, &cpu_affinity_setsize);
1181   if (ret != 0)
1182     goto err;
1183   ret = allocate_cpu_set(&cpu_saved_affinity_set, &cpu_saved_affinity_setsize);
1184   if (ret != 0)
1185     goto err;
1186
1187   ret = for_all_proc_cpus(mark_cpu_present);
1188   if (ret != 0)
1189     goto err;
1190
1191   /*
1192    * For online cpus
1193    * find max_core_id, max_package_id
1194    */
1195   for (unsigned int i = 0; i <= topology.max_cpu_id; ++i) {
1196     unsigned int num_threads;
1197     struct cpu_topology *cpu = &topology.cpus[i];
1198
1199     if (cpu_is_not_present(i)) {
1200       WARNING("turbostat plugin: cpu%d NOT PRESENT", i);
1201       continue;
1202     }
1203
1204     ret = parse_int_file(
1205         "/sys/devices/system/cpu/cpu%d/topology/physical_package_id", i);
1206     if (ret < 0)
1207       goto err;
1208     else
1209       cpu->package_id = (unsigned int)ret;
1210     if (cpu->package_id > max_package_id)
1211       max_package_id = cpu->package_id;
1212
1213     ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", i);
1214     if (ret < 0)
1215       goto err;
1216     else
1217       cpu->core_id = (unsigned int)ret;
1218     if (cpu->core_id > max_core_id)
1219       max_core_id = cpu->core_id;
1220     ret = parse_int_file(
1221         "/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", i);
1222     if (ret < 0)
1223       goto err;
1224     else if ((unsigned int)ret == i)
1225       cpu->first_core_in_package = 1;
1226
1227     ret = get_threads_on_core(i);
1228     if (ret < 0)
1229       goto err;
1230     else
1231       num_threads = (unsigned int)ret;
1232     if (num_threads > max_threads)
1233       max_threads = num_threads;
1234     ret = parse_int_file(
1235         "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", i);
1236     if (ret < 0)
1237       goto err;
1238     else if ((unsigned int)ret == i)
1239       cpu->first_thread_in_core = 1;
1240
1241     DEBUG("turbostat plugin: cpu %d pkg %d core %d\n", i, cpu->package_id,
1242           cpu->core_id);
1243   }
1244   /* Num is max + 1 (need to count 0) */
1245   topology.num_packages = max_package_id + 1;
1246   topology.num_cores = max_core_id + 1;
1247   topology.num_threads = max_threads;
1248
1249   return 0;
1250 err:
1251   free(topology.cpus);
1252   return ret;
1253 }
1254
1255 /************************
1256  * Main alloc/init/free *
1257  ************************/
1258
1259 static int allocate_counters(struct thread_data **threads,
1260                              struct core_data **cores,
1261                              struct pkg_data **packages) {
1262   unsigned int total_threads, total_cores;
1263
1264   if ((topology.num_threads == 0) || (topology.num_cores == 0) ||
1265       (topology.num_packages == 0)) {
1266     ERROR(
1267         "turbostat plugin: Invalid topology: %u threads, %u cores, %u packages",
1268         topology.num_threads, topology.num_cores, topology.num_packages);
1269     return -1;
1270   }
1271
1272   total_threads =
1273       topology.num_threads * topology.num_cores * topology.num_packages;
1274   *threads = calloc(total_threads, sizeof(struct thread_data));
1275   if (*threads == NULL) {
1276     ERROR("turbostat plugin: calloc failed");
1277     return -1;
1278   }
1279
1280   for (unsigned int i = 0; i < total_threads; ++i)
1281     (*threads)[i].cpu_id = topology.max_cpu_id + 1;
1282
1283   total_cores = topology.num_cores * topology.num_packages;
1284   *cores = calloc(total_cores, sizeof(struct core_data));
1285   if (*cores == NULL) {
1286     ERROR("turbostat plugin: calloc failed");
1287     sfree(threads);
1288     return -1;
1289   }
1290
1291   *packages = calloc(topology.num_packages, sizeof(struct pkg_data));
1292   if (*packages == NULL) {
1293     ERROR("turbostat plugin: calloc failed");
1294     sfree(cores);
1295     sfree(threads);
1296     return -1;
1297   }
1298
1299   return 0;
1300 }
1301
1302 static void init_counter(struct thread_data *thread_base,
1303                          struct core_data *core_base, struct pkg_data *pkg_base,
1304                          unsigned int cpu_id) {
1305   struct thread_data *t;
1306   struct core_data *c;
1307   struct pkg_data *p;
1308   struct cpu_topology *cpu = &topology.cpus[cpu_id];
1309
1310   t = GET_THREAD(thread_base, !(cpu->first_thread_in_core), cpu->core_id,
1311                  cpu->package_id);
1312   c = GET_CORE(core_base, cpu->core_id, cpu->package_id);
1313   p = GET_PKG(pkg_base, cpu->package_id);
1314
1315   t->cpu_id = cpu_id;
1316   if (cpu->first_thread_in_core)
1317     t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1318   if (cpu->first_core_in_package)
1319     t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1320
1321   c->core_id = cpu->core_id;
1322   p->package_id = cpu->package_id;
1323 }
1324
1325 static void initialize_counters(void) {
1326   for (unsigned int cpu_id = 0; cpu_id <= topology.max_cpu_id; ++cpu_id) {
1327     if (cpu_is_not_present(cpu_id))
1328       continue;
1329     init_counter(EVEN_COUNTERS, cpu_id);
1330     init_counter(ODD_COUNTERS, cpu_id);
1331     init_counter(DELTA_COUNTERS, cpu_id);
1332   }
1333 }
1334
1335 static void free_all_buffers(void) {
1336   allocated = 0;
1337   initialized = 0;
1338
1339   CPU_FREE(cpu_present_set);
1340   cpu_present_set = NULL;
1341   cpu_present_setsize = 0;
1342
1343   CPU_FREE(cpu_affinity_set);
1344   cpu_affinity_set = NULL;
1345   cpu_affinity_setsize = 0;
1346
1347   CPU_FREE(cpu_saved_affinity_set);
1348   cpu_saved_affinity_set = NULL;
1349   cpu_saved_affinity_setsize = 0;
1350
1351   free(thread_even);
1352   free(core_even);
1353   free(package_even);
1354
1355   thread_even = NULL;
1356   core_even = NULL;
1357   package_even = NULL;
1358
1359   free(thread_odd);
1360   free(core_odd);
1361   free(package_odd);
1362
1363   thread_odd = NULL;
1364   core_odd = NULL;
1365   package_odd = NULL;
1366
1367   free(thread_delta);
1368   free(core_delta);
1369   free(package_delta);
1370
1371   thread_delta = NULL;
1372   core_delta = NULL;
1373   package_delta = NULL;
1374 }
1375
1376 /**********************
1377  * Collectd functions *
1378  **********************/
1379
1380 #define DO_OR_GOTO_ERR(something)                                              \
1381   do {                                                                         \
1382     ret = (something);                                                         \
1383     if (ret < 0)                                                               \
1384       goto err;                                                                \
1385   } while (0)
1386
1387 static int setup_all_buffers(void) {
1388   int ret;
1389
1390   DO_OR_GOTO_ERR(topology_probe());
1391   DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1392   DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1393   DO_OR_GOTO_ERR(allocate_counters(&thread_delta, &core_delta, &package_delta));
1394   initialize_counters();
1395   DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1396   DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, ODD_COUNTERS));
1397
1398   allocated = 1;
1399   return 0;
1400 err:
1401   free_all_buffers();
1402   return ret;
1403 }
1404
1405 static int turbostat_read(void) {
1406   int ret;
1407
1408   if (!allocated) {
1409     if ((ret = setup_all_buffers()) < 0)
1410       return ret;
1411   }
1412
1413   if (for_all_proc_cpus(cpu_is_not_present)) {
1414     free_all_buffers();
1415     if ((ret = setup_all_buffers()) < 0)
1416       return ret;
1417     if (for_all_proc_cpus(cpu_is_not_present)) {
1418       ERROR("turbostat plugin: CPU appeared just after "
1419             "initialization");
1420       return -1;
1421     }
1422   }
1423
1424   /* Saving the scheduling affinity, as it will be modified by get_counters */
1425   if (sched_getaffinity(0, cpu_saved_affinity_setsize,
1426                         cpu_saved_affinity_set) != 0) {
1427     ERROR("turbostat plugin: Unable to save the CPU affinity");
1428     return -1;
1429   }
1430
1431   if (!initialized) {
1432     if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1433       goto out;
1434     time_even = cdtime();
1435     is_even = 1;
1436     initialized = 1;
1437     ret = 0;
1438     goto out;
1439   }
1440
1441   if (is_even) {
1442     if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
1443       goto out;
1444     time_odd = cdtime();
1445     is_even = 0;
1446     time_delta = time_odd - time_even;
1447     if ((ret = for_all_cpus_delta(ODD_COUNTERS, EVEN_COUNTERS)) < 0)
1448       goto out;
1449     if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1450       goto out;
1451   } else {
1452     if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1453       goto out;
1454     time_even = cdtime();
1455     is_even = 1;
1456     time_delta = time_even - time_odd;
1457     if ((ret = for_all_cpus_delta(EVEN_COUNTERS, ODD_COUNTERS)) < 0)
1458       goto out;
1459     if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1460       goto out;
1461   }
1462   ret = 0;
1463 out:
1464   /*
1465    * Let's restore the affinity
1466    * This might fail if the number of CPU changed, but we can't do anything in
1467    * that case..
1468    */
1469   (void)sched_setaffinity(0, cpu_saved_affinity_setsize,
1470                           cpu_saved_affinity_set);
1471   return ret;
1472 }
1473
1474 static int check_permissions(void) {
1475
1476   if (getuid() == 0) {
1477     /* We have everything we need */
1478     return 0;
1479 #if !defined(HAVE_SYS_CAPABILITY_H) && !defined(CAP_SYS_RAWIO)
1480   } else {
1481     ERROR("turbostat plugin: Initialization failed: this plugin "
1482           "requires collectd to run as root");
1483     return -1;
1484   }
1485 #else  /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1486   }
1487
1488   int ret = 0;
1489
1490   if (check_capability(CAP_SYS_RAWIO) != 0) {
1491     WARNING("turbostat plugin: Collectd doesn't have the "
1492             "CAP_SYS_RAWIO capability. If you don't want to run "
1493             "collectd as root, try running \"setcap "
1494             "cap_sys_rawio=ep\" on collectd binary");
1495     ret = -1;
1496   }
1497
1498   if (euidaccess("/dev/cpu/0/msr", R_OK)) {
1499     WARNING("turbostat plugin: Collectd cannot open "
1500             "/dev/cpu/0/msr. If you don't want to run collectd as "
1501             "root, you need to change the ownership (chown) and "
1502             "permissions on /dev/cpu/*/msr to allow such access");
1503     ret = -1;
1504   }
1505
1506   if (ret != 0)
1507     ERROR("turbostat plugin: Initialization failed: this plugin "
1508           "requires collectd to either to run as root or give "
1509           "collectd a special capability (CAP_SYS_RAWIO) and read "
1510           "access to /dev/cpu/*/msr (see previous warnings)");
1511   return ret;
1512 #endif /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1513 }
1514
1515 static int turbostat_init(void) {
1516   struct stat sb;
1517   int ret;
1518
1519   if (stat("/dev/cpu/0/msr", &sb)) {
1520     ERROR("turbostat plugin: Initialization failed: /dev/cpu/0/msr "
1521           "does not exist while the CPU supports MSR. You may be "
1522           "missing the corresponding kernel module, please try '# "
1523           "modprobe msr'");
1524     return -1;
1525   }
1526
1527   DO_OR_GOTO_ERR(check_permissions());
1528
1529   DO_OR_GOTO_ERR(probe_cpu());
1530
1531   DO_OR_GOTO_ERR(setup_all_buffers());
1532
1533   plugin_register_read(PLUGIN_NAME, turbostat_read);
1534
1535   return 0;
1536 err:
1537   free_all_buffers();
1538   return ret;
1539 }
1540
1541 static int turbostat_config(const char *key, const char *value) {
1542   long unsigned int tmp_val;
1543   char *end;
1544
1545   if (strcasecmp("CoreCstates", key) == 0) {
1546     tmp_val = strtoul(value, &end, 0);
1547     if (*end != '\0' || tmp_val > UINT_MAX) {
1548       ERROR("turbostat plugin: Invalid CoreCstates '%s'", value);
1549       return -1;
1550     }
1551     config_core_cstate = (unsigned int)tmp_val;
1552     apply_config_core_cstate = 1;
1553   } else if (strcasecmp("PackageCstates", key) == 0) {
1554     tmp_val = strtoul(value, &end, 0);
1555     if (*end != '\0' || tmp_val > UINT_MAX) {
1556       ERROR("turbostat plugin: Invalid PackageCstates '%s'", value);
1557       return -1;
1558     }
1559     config_pkg_cstate = (unsigned int)tmp_val;
1560     apply_config_pkg_cstate = 1;
1561   } else if (strcasecmp("SystemManagementInterrupt", key) == 0) {
1562     config_smi = IS_TRUE(value);
1563     apply_config_smi = 1;
1564   } else if (strcasecmp("DigitalTemperatureSensor", key) == 0) {
1565     config_dts = IS_TRUE(value);
1566     apply_config_dts = 1;
1567   } else if (strcasecmp("PackageThermalManagement", key) == 0) {
1568     config_ptm = IS_TRUE(value);
1569     apply_config_ptm = 1;
1570   } else if (strcasecmp("LogicalCoreNames", key) == 0) {
1571     config_lcn = IS_TRUE(value);
1572   } else if (strcasecmp("RunningAveragePowerLimit", key) == 0) {
1573     tmp_val = strtoul(value, &end, 0);
1574     if (*end != '\0' || tmp_val > UINT_MAX) {
1575       ERROR("turbostat plugin: Invalid RunningAveragePowerLimit '%s'", value);
1576       return -1;
1577     }
1578     config_rapl = (unsigned int)tmp_val;
1579     apply_config_rapl = 1;
1580   } else if (strcasecmp("TCCActivationTemp", key) == 0) {
1581     tmp_val = strtoul(value, &end, 0);
1582     if (*end != '\0' || tmp_val > UINT_MAX) {
1583       ERROR("turbostat plugin: Invalid TCCActivationTemp '%s'", value);
1584       return -1;
1585     }
1586     tcc_activation_temp = (unsigned int)tmp_val;
1587   } else {
1588     ERROR("turbostat plugin: Invalid configuration option '%s'", key);
1589     return -1;
1590   }
1591   return 0;
1592 }
1593
1594 void module_register(void) {
1595   plugin_register_init(PLUGIN_NAME, turbostat_init);
1596   plugin_register_config(PLUGIN_NAME, turbostat_config, config_keys,
1597                          config_keys_num);
1598 }