2 * turbostat -- Log CPU frequency and C-state residency
3 * on modern Intel turbo-capable processors for collectd.
5 * Based on the 'turbostat' tool of the Linux kernel, found at
6 * linux/tools/power/x86/turbostat/turbostat.c:
8 * Copyright (c) 2013 Intel Corporation.
9 * Len Brown <len.brown@intel.com>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms and conditions of the GNU General Public License,
13 * version 2, as published by the Free Software Foundation.
15 * This program is distributed in the hope it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
24 * Ported to collectd by Vincent Brillault <git@lerya.net>
28 * _GNU_SOURCE is required because of the following functions:
38 #include <asm/msr-index.h>
43 #include <sys/types.h>
46 #include <sys/resource.h>
61 #define PLUGIN_NAME "turbostat"
63 static const char *proc_stat = "/proc/stat";
64 static unsigned int skip_c0;
65 static unsigned int skip_c1;
66 static unsigned int do_nhm_cstates;
67 static unsigned int do_snb_cstates;
68 static unsigned int do_c8_c9_c10;
69 static unsigned int do_slm_cstates;
70 static unsigned int has_aperf;
71 static unsigned int has_epb;
72 static unsigned int genuine_intel;
73 static unsigned int do_nehalem_platform_info;
75 static unsigned int do_rapl;
76 static unsigned int do_dts;
77 static unsigned int do_ptm;
78 static unsigned int tcc_activation_temp;
79 static unsigned int tcc_activation_temp_override;
80 static double rapl_power_units, rapl_energy_units, rapl_time_units;
81 static double rapl_joule_counter_range;
83 #define RAPL_PKG (1 << 0)
84 /* 0x610 MSR_PKG_POWER_LIMIT */
85 /* 0x611 MSR_PKG_ENERGY_STATUS */
86 #define RAPL_PKG_PERF_STATUS (1 << 1)
87 /* 0x613 MSR_PKG_PERF_STATUS */
88 #define RAPL_PKG_POWER_INFO (1 << 2)
89 /* 0x614 MSR_PKG_POWER_INFO */
91 #define RAPL_DRAM (1 << 3)
92 /* 0x618 MSR_DRAM_POWER_LIMIT */
93 /* 0x619 MSR_DRAM_ENERGY_STATUS */
94 /* 0x61c MSR_DRAM_POWER_INFO */
95 #define RAPL_DRAM_PERF_STATUS (1 << 4)
96 /* 0x61b MSR_DRAM_PERF_STATUS */
98 #define RAPL_CORES (1 << 5)
99 /* 0x638 MSR_PP0_POWER_LIMIT */
100 /* 0x639 MSR_PP0_ENERGY_STATUS */
101 #define RAPL_CORE_POLICY (1 << 6)
102 /* 0x63a MSR_PP0_POLICY */
105 #define RAPL_GFX (1 << 7)
106 /* 0x640 MSR_PP1_POWER_LIMIT */
107 /* 0x641 MSR_PP1_ENERGY_STATUS */
108 /* 0x642 MSR_PP1_POLICY */
109 #define TJMAX_DEFAULT 100
111 int aperf_mperf_unstable;
115 cpu_set_t *cpu_present_set, *cpu_affinity_set;
116 size_t cpu_present_setsize, cpu_affinity_setsize;
119 unsigned long long tsc;
120 unsigned long long aperf;
121 unsigned long long mperf;
122 unsigned long long c1;
123 unsigned int smi_count;
126 #define CPU_IS_FIRST_THREAD_IN_CORE 0x2
127 #define CPU_IS_FIRST_CORE_IN_PACKAGE 0x4
128 } *thread_even, *thread_odd;
131 unsigned long long c3;
132 unsigned long long c6;
133 unsigned long long c7;
134 unsigned int core_temp_c;
135 unsigned int core_id;
136 } *core_even, *core_odd;
139 unsigned long long pc2;
140 unsigned long long pc3;
141 unsigned long long pc6;
142 unsigned long long pc7;
143 unsigned long long pc8;
144 unsigned long long pc9;
145 unsigned long long pc10;
146 unsigned int package_id;
147 unsigned int energy_pkg; /* MSR_PKG_ENERGY_STATUS */
148 unsigned int energy_dram; /* MSR_DRAM_ENERGY_STATUS */
149 unsigned int energy_cores; /* MSR_PP0_ENERGY_STATUS */
150 unsigned int energy_gfx; /* MSR_PP1_ENERGY_STATUS */
151 unsigned int rapl_pkg_perf_status; /* MSR_PKG_PERF_STATUS */
152 unsigned int rapl_dram_perf_status; /* MSR_DRAM_PERF_STATUS */
153 unsigned int pkg_temp_c;
155 } *package_even, *package_odd;
157 #define ODD_COUNTERS thread_odd, core_odd, package_odd
158 #define EVEN_COUNTERS thread_even, core_even, package_even
159 static _Bool is_even = 1;
161 static _Bool allocated = 0;
162 static _Bool initialized = 0;
164 #define GET_THREAD(thread_base, thread_no, core_no, pkg_no) \
165 (thread_base + (pkg_no) * topo.num_cores_per_pkg * \
166 topo.num_threads_per_core + \
167 (core_no) * topo.num_threads_per_core + (thread_no))
168 #define GET_CORE(core_base, core_no, pkg_no) \
169 (core_base + (pkg_no) * topo.num_cores_per_pkg + (core_no))
170 #define GET_PKG(pkg_base, pkg_no) (pkg_base + pkg_no)
177 int num_cores_per_pkg;
178 int num_threads_per_core;
181 struct timeval tv_even, tv_odd, tv_delta;
189 ERR_MSR_CORE_C3_RESIDENCY,
190 ERR_MSR_CORE_C6_RESIDENCY,
191 ERR_MSR_CORE_C7_RESIDENCY,
192 ERR_MSR_IA32_THERM_STATUS,
193 ERR_MSR_PKG_C3_RESIDENCY,
194 ERR_MSR_PKG_C6_RESIDENCY,
195 ERR_MSR_PKG_C2_RESIDENCY,
196 ERR_MSR_PKG_C7_RESIDENCY,
197 ERR_MSR_PKG_C8_RESIDENCY,
198 ERR_MSR_PKG_C9_RESIDENCY,
199 ERR_MSR_PKG_C10_RESIDENCY,
200 ERR_MSR_PKG_ENERGY_STATUS,
201 ERR_MSR_PP0_ENERGY_STATUS,
202 ERR_MSR_DRAM_ENERGY_STATUS,
203 ERR_MSR_PP1_ENERGY_STATUS,
204 ERR_MSR_PKG_PERF_STATUS,
205 ERR_MSR_DRAM_PERF_STATUS,
206 ERR_MSR_IA32_PACKAGE_THERM_STATUS,
210 ERR_CANT_READ_NUMBER,
211 ERR_CANT_READ_PROC_STAT,
212 ERR_NO_INVARIANT_TSC,
219 static int setup_all_buffers(void);
222 cpu_is_not_present(int cpu)
224 return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
227 * run func(thread, core, package) in topology order
228 * skip non-present cpus
231 static int __attribute__((warn_unused_result))
232 for_all_cpus(int (func)(struct thread_data *, struct core_data *, struct pkg_data *),
233 struct thread_data *thread_base, struct core_data *core_base, struct pkg_data *pkg_base)
235 int retval, pkg_no, core_no, thread_no;
237 for (pkg_no = 0; pkg_no < topo.num_packages; ++pkg_no) {
238 for (core_no = 0; core_no < topo.num_cores_per_pkg; ++core_no) {
239 for (thread_no = 0; thread_no <
240 topo.num_threads_per_core; ++thread_no) {
241 struct thread_data *t;
245 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
247 if (cpu_is_not_present(t->cpu_id))
250 c = GET_CORE(core_base, core_no, pkg_no);
251 p = GET_PKG(pkg_base, pkg_no);
253 retval = func(t, c, p);
262 static int __attribute__((warn_unused_result))
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 return -ERR_CPU_MIGRATE;
273 static int __attribute__((warn_unused_result))
274 get_msr(int cpu, off_t offset, unsigned long long *msr)
280 ssnprintf(pathname, 32, "/dev/cpu/%d/msr", cpu);
281 fd = open(pathname, O_RDONLY);
285 retval = pread(fd, msr, sizeof *msr, offset);
288 if (retval != sizeof *msr) {
289 ERROR ("%s offset 0x%llx read failed\n", pathname, (unsigned long long)offset);
296 #define DELTA_WRAP32(new, old) \
300 old = 0x100000000 + new - old; \
304 delta_package(struct pkg_data *new, struct pkg_data *old)
306 old->pc2 = new->pc2 - old->pc2;
307 old->pc3 = new->pc3 - old->pc3;
308 old->pc6 = new->pc6 - old->pc6;
309 old->pc7 = new->pc7 - old->pc7;
310 old->pc8 = new->pc8 - old->pc8;
311 old->pc9 = new->pc9 - old->pc9;
312 old->pc10 = new->pc10 - old->pc10;
313 old->pkg_temp_c = new->pkg_temp_c;
315 DELTA_WRAP32(new->energy_pkg, old->energy_pkg);
316 DELTA_WRAP32(new->energy_cores, old->energy_cores);
317 DELTA_WRAP32(new->energy_gfx, old->energy_gfx);
318 DELTA_WRAP32(new->energy_dram, old->energy_dram);
319 DELTA_WRAP32(new->rapl_pkg_perf_status, old->rapl_pkg_perf_status);
320 DELTA_WRAP32(new->rapl_dram_perf_status, old->rapl_dram_perf_status);
324 delta_core(struct core_data *new, struct core_data *old)
326 old->c3 = new->c3 - old->c3;
327 old->c6 = new->c6 - old->c6;
328 old->c7 = new->c7 - old->c7;
329 old->core_temp_c = new->core_temp_c;
335 static int __attribute__((warn_unused_result))
336 delta_thread(struct thread_data *new, struct thread_data *old,
337 struct core_data *core_delta)
339 old->tsc = new->tsc - old->tsc;
341 /* check for TSC < 1 Mcycles over interval */
342 if (old->tsc < (1000 * 1000)) {
343 WARNING("Insanely slow TSC rate, TSC stops in idle?\n"
344 "You can disable all c-states by booting with \"idle=poll\"\n"
345 "or just the deep ones with \"processor.max_cstate=1\"");
349 old->c1 = new->c1 - old->c1;
351 if ((new->aperf > old->aperf) && (new->mperf > old->mperf)) {
352 old->aperf = new->aperf - old->aperf;
353 old->mperf = new->mperf - old->mperf;
356 if (!aperf_mperf_unstable) {
357 WARNING("%s: APERF or MPERF went backwards *\n", progname);
358 WARNING("* Frequency results do not cover entire interval *\n");
359 WARNING("* fix this by running Linux-2.6.30 or later *\n");
361 aperf_mperf_unstable = 1;
364 * mperf delta is likely a huge "positive" number
365 * can not use it for calculating c0 time
373 * As counter collection is not atomic,
374 * it is possible for mperf's non-halted cycles + idle states
375 * to exceed TSC's all cycles: show c1 = 0% in that case.
377 if ((old->mperf + core_delta->c3 + core_delta->c6 + core_delta->c7) > old->tsc)
380 /* normal case, derive c1 */
381 old->c1 = old->tsc - old->mperf - core_delta->c3
382 - core_delta->c6 - core_delta->c7;
385 if (old->mperf == 0) {
386 WARNING("cpu%d MPERF 0!\n", old->cpu_id);
387 old->mperf = 1; /* divide by 0 protection */
391 old->smi_count = new->smi_count - old->smi_count;
396 static int __attribute__((warn_unused_result))
397 delta_cpu(struct thread_data *t, struct core_data *c,
398 struct pkg_data *p, struct thread_data *t2,
399 struct core_data *c2, struct pkg_data *p2)
403 /* calculate core delta only for 1st thread in core */
404 if (t->flags & CPU_IS_FIRST_THREAD_IN_CORE)
407 /* always calculate thread delta */
408 ret = delta_thread(t, t2, c2); /* c2 is core delta */
412 /* calculate package delta only for 1st core in package */
413 if (t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)
414 delta_package(p, p2);
419 static unsigned long long
422 unsigned int low, high;
424 asm volatile("rdtsc" : "=a" (low), "=d" (high));
426 return low | ((unsigned long long)high) << 32;
433 * acquire and record local counters for that cpu
435 static int __attribute__((warn_unused_result))
436 get_counters(struct thread_data *t, struct core_data *c, struct pkg_data *p)
439 unsigned long long msr;
441 if (cpu_migrate(cpu)) {
442 WARNING("Could not migrate to CPU %d\n", cpu);
443 return -ERR_CPU_MIGRATE;
446 t->tsc = rdtsc(); /* we are running on local CPU of interest */
449 if (get_msr(cpu, MSR_IA32_APERF, &t->aperf))
450 return -ERR_MSR_IA32_APERF;
451 if (get_msr(cpu, MSR_IA32_MPERF, &t->mperf))
452 return -ERR_MSR_IA32_MPERF;
456 if (get_msr(cpu, MSR_SMI_COUNT, &msr))
457 return -ERR_MSR_SMI_COUNT;
458 t->smi_count = msr & 0xFFFFFFFF;
461 /* collect core counters only for 1st thread in core */
462 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
465 if (do_nhm_cstates && !do_slm_cstates) {
466 if (get_msr(cpu, MSR_CORE_C3_RESIDENCY, &c->c3))
467 return -ERR_MSR_CORE_C3_RESIDENCY;
470 if (do_nhm_cstates) {
471 if (get_msr(cpu, MSR_CORE_C6_RESIDENCY, &c->c6))
472 return -ERR_MSR_CORE_C6_RESIDENCY;
476 if (get_msr(cpu, MSR_CORE_C7_RESIDENCY, &c->c7))
477 return -ERR_MSR_CORE_C7_RESIDENCY;
480 if (get_msr(cpu, MSR_IA32_THERM_STATUS, &msr))
481 return -ERR_MSR_IA32_THERM_STATUS;
482 c->core_temp_c = tcc_activation_temp - ((msr >> 16) & 0x7F);
486 /* collect package counters only for 1st core in package */
487 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
490 if (do_nhm_cstates && !do_slm_cstates) {
491 if (get_msr(cpu, MSR_PKG_C3_RESIDENCY, &p->pc3))
492 return -ERR_MSR_PKG_C3_RESIDENCY;
493 if (get_msr(cpu, MSR_PKG_C6_RESIDENCY, &p->pc6))
494 return -ERR_MSR_PKG_C6_RESIDENCY;
496 if (do_snb_cstates) {
497 if (get_msr(cpu, MSR_PKG_C2_RESIDENCY, &p->pc2))
498 return -ERR_MSR_PKG_C2_RESIDENCY;
499 if (get_msr(cpu, MSR_PKG_C7_RESIDENCY, &p->pc7))
500 return -ERR_MSR_PKG_C7_RESIDENCY;
503 if (get_msr(cpu, MSR_PKG_C8_RESIDENCY, &p->pc8))
504 return -ERR_MSR_PKG_C8_RESIDENCY;
505 if (get_msr(cpu, MSR_PKG_C9_RESIDENCY, &p->pc9))
506 return -ERR_MSR_PKG_C9_RESIDENCY;
507 if (get_msr(cpu, MSR_PKG_C10_RESIDENCY, &p->pc10))
508 return -ERR_MSR_PKG_C10_RESIDENCY;
510 if (do_rapl & RAPL_PKG) {
511 if (get_msr(cpu, MSR_PKG_ENERGY_STATUS, &msr))
512 return -ERR_MSR_PKG_ENERGY_STATUS;
513 p->energy_pkg = msr & 0xFFFFFFFF;
515 if (do_rapl & RAPL_CORES) {
516 if (get_msr(cpu, MSR_PP0_ENERGY_STATUS, &msr))
517 return MSR_PP0_ENERGY_STATUS;
518 p->energy_cores = msr & 0xFFFFFFFF;
520 if (do_rapl & RAPL_DRAM) {
521 if (get_msr(cpu, MSR_DRAM_ENERGY_STATUS, &msr))
522 return -ERR_MSR_DRAM_ENERGY_STATUS;
523 p->energy_dram = msr & 0xFFFFFFFF;
525 if (do_rapl & RAPL_GFX) {
526 if (get_msr(cpu, MSR_PP1_ENERGY_STATUS, &msr))
527 return -ERR_MSR_PP1_ENERGY_STATUS;
528 p->energy_gfx = msr & 0xFFFFFFFF;
530 if (do_rapl & RAPL_PKG_PERF_STATUS) {
531 if (get_msr(cpu, MSR_PKG_PERF_STATUS, &msr))
532 return -ERR_MSR_PKG_PERF_STATUS;
533 p->rapl_pkg_perf_status = msr & 0xFFFFFFFF;
535 if (do_rapl & RAPL_DRAM_PERF_STATUS) {
536 if (get_msr(cpu, MSR_DRAM_PERF_STATUS, &msr))
537 return -ERR_MSR_DRAM_PERF_STATUS;
538 p->rapl_dram_perf_status = msr & 0xFFFFFFFF;
541 if (get_msr(cpu, MSR_IA32_PACKAGE_THERM_STATUS, &msr))
542 return -ERR_MSR_IA32_PACKAGE_THERM_STATUS;
543 p->pkg_temp_c = tcc_activation_temp - ((msr >> 16) & 0x7F);
549 free_all_buffers(void)
554 CPU_FREE(cpu_present_set);
555 cpu_present_set = NULL;
558 CPU_FREE(cpu_affinity_set);
559 cpu_affinity_set = NULL;
560 cpu_affinity_setsize = 0;
580 * Parse a file containing a single int.
582 static int __attribute__ ((format(printf,1,2)))
583 parse_int_file(const char *fmt, ...)
591 vsnprintf(path, sizeof(path), fmt, args);
593 filep = fopen(path, "r");
595 ERROR("%s: open failed", path);
596 return -ERR_CANT_OPEN_FILE;
598 if (fscanf(filep, "%d", &value) != 1) {
599 ERROR("%s: failed to parse number from file", path);
600 return -ERR_CANT_READ_NUMBER;
607 * cpu_is_first_sibling_in_core(cpu)
608 * return 1 if given CPU is 1st HT sibling in the core
611 cpu_is_first_sibling_in_core(int cpu)
613 return cpu == parse_int_file("/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
617 * cpu_is_first_core_in_package(cpu)
618 * return 1 if given CPU is 1st core in package
621 cpu_is_first_core_in_package(int cpu)
623 return cpu == parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", cpu);
627 get_physical_package_id(int cpu)
629 return parse_int_file("/sys/devices/system/cpu/cpu%d/topology/physical_package_id", cpu);
635 return parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", cpu);
639 get_num_ht_siblings(int cpu)
647 ssnprintf(path, 80, "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
648 filep = fopen(path, "r");
650 ERROR("%s: open failed", path);
651 return -ERR_CANT_OPEN_FILE;
655 * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
656 * otherwinse 1 sibling (self).
658 matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
669 * run func(thread, core, package) in topology order
670 * skip non-present cpus
674 static int __attribute__((warn_unused_result))
675 for_all_cpus_2(int (func)(struct thread_data *, struct core_data *,
676 struct pkg_data *, struct thread_data *, struct core_data *,
677 struct pkg_data *), struct thread_data *thread_base,
678 struct core_data *core_base, struct pkg_data *pkg_base,
679 struct thread_data *thread_base2, struct core_data *core_base2,
680 struct pkg_data *pkg_base2)
682 int retval, pkg_no, core_no, thread_no;
684 for (pkg_no = 0; pkg_no < topo.num_packages; ++pkg_no) {
685 for (core_no = 0; core_no < topo.num_cores_per_pkg; ++core_no) {
686 for (thread_no = 0; thread_no <
687 topo.num_threads_per_core; ++thread_no) {
688 struct thread_data *t, *t2;
689 struct core_data *c, *c2;
690 struct pkg_data *p, *p2;
692 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
694 if (cpu_is_not_present(t->cpu_id))
697 t2 = GET_THREAD(thread_base2, thread_no, core_no, pkg_no);
699 c = GET_CORE(core_base, core_no, pkg_no);
700 c2 = GET_CORE(core_base2, core_no, pkg_no);
702 p = GET_PKG(pkg_base, pkg_no);
703 p2 = GET_PKG(pkg_base2, pkg_no);
705 retval = func(t, c, p, t2, c2, p2);
715 * run func(cpu) on every cpu in /proc/stat
716 * return max_cpu number
718 static int __attribute__((warn_unused_result))
719 for_all_proc_cpus(int (func)(int))
725 fp = fopen(proc_stat, "r");
727 ERROR("%s: open failed", proc_stat);
728 return -ERR_CANT_OPEN_FILE;
731 retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
733 ERROR("%s: failed to parse format", proc_stat);
734 return -ERR_CANT_READ_PROC_STAT;
738 retval = fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
742 retval = func(cpu_num);
754 * remember the last one seen, it will be the max
759 if (topo.max_cpu_num < cpu)
760 topo.max_cpu_num = cpu;
766 mark_cpu_present(int cpu)
768 CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
774 turbostat_submit (const char *plugin_instance,
775 const char *type, const char *type_instance,
778 value_list_t vl = VALUE_LIST_INIT;
784 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
785 sstrncpy (vl.plugin, PLUGIN_NAME, sizeof (vl.plugin));
786 if (plugin_instance != NULL)
787 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
788 sstrncpy (vl.type, type, sizeof (vl.type));
789 if (type_instance != NULL)
790 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
792 plugin_dispatch_values (&vl);
796 * column formatting convention & formats
797 * package: "pk" 2 columns %2d
798 * core: "cor" 3 columns %3d
799 * CPU: "CPU" 3 columns %3d
804 * GHz: "GHz" 3 columns %3.2
805 * TSC: "TSC" 3 columns %3.2
806 * SMI: "SMI" 4 columns %4d
807 * percentage " %pc3" %6.2
808 * Perf Status percentage: %5.2
809 * "CTMP" 4 columns %4d
813 submit_counters(struct thread_data *t, struct core_data *c,
817 double interval_float;
819 interval_float = tv_delta.tv_sec + tv_delta.tv_usec/1000000.0;
821 snprintf(name, NAME_LEN, "cpu%02d", t->cpu_id);
823 if (do_nhm_cstates) {
825 turbostat_submit(name, "percent", "c0", 100.0 * t->mperf/t->tsc);
827 turbostat_submit(name, "percent", "c1", 100.0 * t->c1/t->tsc);
831 if (has_aperf && ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc))))
832 turbostat_submit(NULL, "frequency", name, 1.0 * t->tsc / 1000000000 * t->aperf / t->mperf / interval_float);
836 turbostat_submit(NULL, "current", name, t->smi_count);
838 /* print per-core data only for 1st thread in core */
839 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
842 snprintf(name, NAME_LEN, "core%02d", c->core_id);
844 if (do_nhm_cstates && !do_slm_cstates)
845 turbostat_submit(name, "percent", "c3", 100.0 * c->c3/t->tsc);
847 turbostat_submit(name, "percent", "c6", 100.0 * c->c6/t->tsc);
849 turbostat_submit(name, "percent", "c7", 100.0 * c->c7/t->tsc);
852 turbostat_submit(NULL, "temperature", name, c->core_temp_c);
854 /* print per-package data only for 1st core in package */
855 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
858 snprintf(name, NAME_LEN, "pkg%02d", p->package_id);
861 turbostat_submit(NULL, "temperature", name, p->pkg_temp_c);
864 turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2/t->tsc);
865 if (do_nhm_cstates && !do_slm_cstates)
866 turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3/t->tsc);
867 if (do_nhm_cstates && !do_slm_cstates)
868 turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6/t->tsc);
870 turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7/t->tsc);
872 turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8/t->tsc);
873 turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9/t->tsc);
874 turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10/t->tsc);
878 if (do_rapl & RAPL_PKG)
879 turbostat_submit(name, "power", "Pkg_W", p->energy_pkg * rapl_energy_units / interval_float);
880 if (do_rapl & RAPL_CORES)
881 turbostat_submit(name, "power", "Cor_W", p->energy_cores * rapl_energy_units / interval_float);
882 if (do_rapl & RAPL_GFX)
883 turbostat_submit(name, "power", "GFX_W", p->energy_gfx * rapl_energy_units / interval_float);
884 if (do_rapl & RAPL_DRAM)
885 turbostat_submit(name, "power", "RAM_W", p->energy_dram * rapl_energy_units / interval_float);
892 turbostat_read(user_data_t * not_used)
897 if ((ret = setup_all_buffers()) < 0)
901 if (for_all_proc_cpus(cpu_is_not_present)) {
903 if ((ret = setup_all_buffers()) < 0)
905 if (for_all_proc_cpus(cpu_is_not_present))
906 return -ERR_CPU_NOT_PRESENT;
910 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
912 gettimeofday(&tv_even, (struct timezone *)NULL);
919 if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
921 gettimeofday(&tv_odd, (struct timezone *)NULL);
923 timersub(&tv_odd, &tv_even, &tv_delta);
924 if ((ret = for_all_cpus_2(delta_cpu, ODD_COUNTERS, EVEN_COUNTERS)) < 0)
926 if ((ret = for_all_cpus(submit_counters, EVEN_COUNTERS)) < 0)
929 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
931 gettimeofday(&tv_even, (struct timezone *)NULL);
933 timersub(&tv_even, &tv_odd, &tv_delta);
934 if ((ret = for_all_cpus_2(delta_cpu, EVEN_COUNTERS, ODD_COUNTERS)) < 0)
936 if ((ret = for_all_cpus(submit_counters, ODD_COUNTERS)) < 0)
942 static int __attribute__((warn_unused_result))
947 if (stat("/dev/cpu/0/msr", &sb)) {
948 ERROR("no /dev/cpu/0/msr\n"
949 "Try \"# modprobe msr\"");
955 static int __attribute__((warn_unused_result))
959 ERROR("must be root");
960 return -ERR_NOT_ROOT;
966 #define RAPL_POWER_GRANULARITY 0x7FFF /* 15 bit power granularity */
967 #define RAPL_TIME_GRANULARITY 0x3F /* 6 bit time granularity */
970 get_tdp(unsigned int model)
972 unsigned long long msr;
974 if (do_rapl & RAPL_PKG_POWER_INFO)
975 if (!get_msr(0, MSR_PKG_POWER_INFO, &msr))
976 return ((msr >> 0) & RAPL_POWER_GRANULARITY) * rapl_power_units;
991 * sets do_rapl, rapl_power_units, rapl_energy_units, rapl_time_units
994 rapl_probe(unsigned int family, unsigned int model)
996 unsigned long long msr;
997 unsigned int time_unit;
1009 case 0x3C: /* HSW */
1010 case 0x45: /* HSW */
1011 case 0x46: /* HSW */
1012 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_CORE_POLICY | RAPL_GFX | RAPL_PKG_POWER_INFO;
1014 case 0x3F: /* HSX */
1015 do_rapl = RAPL_PKG | RAPL_DRAM | RAPL_DRAM_PERF_STATUS | RAPL_PKG_PERF_STATUS | RAPL_PKG_POWER_INFO;
1019 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_CORE_POLICY | RAPL_DRAM | RAPL_PKG_PERF_STATUS | RAPL_DRAM_PERF_STATUS | RAPL_PKG_POWER_INFO;
1021 case 0x37: /* BYT */
1022 case 0x4D: /* AVN */
1023 do_rapl = RAPL_PKG | RAPL_CORES ;
1029 /* units on package 0, verify later other packages match */
1030 if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1033 rapl_power_units = 1.0 / (1 << (msr & 0xF));
1035 rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1037 rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1039 time_unit = msr >> 16 & 0xF;
1043 rapl_time_units = 1.0 / (1 << (time_unit));
1045 tdp = get_tdp(model);
1047 rapl_joule_counter_range = 0xFFFFFFFF * rapl_energy_units / tdp;
1049 // fprintf(stderr, "RAPL: %.0f sec. Joule Counter Range, at %.0f Watts\n", rapl_joule_counter_range, tdp);
1055 is_snb(unsigned int family, unsigned int model)
1063 case 0x3A: /* IVB */
1064 case 0x3E: /* IVB Xeon */
1065 case 0x3C: /* HSW */
1066 case 0x3F: /* HSW */
1067 case 0x45: /* HSW */
1068 case 0x46: /* HSW */
1075 has_c8_c9_c10(unsigned int family, unsigned int model)
1089 is_slm(unsigned int family, unsigned int model)
1094 case 0x37: /* BYT */
1095 case 0x4D: /* AVN */
1102 * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
1103 * the Thermal Control Circuit (TCC) activates.
1104 * This is usually equal to tjMax.
1106 * Older processors do not have this MSR, so there we guess,
1107 * but also allow cmdline over-ride with -T.
1109 * Several MSR temperature values are in units of degrees-C
1110 * below this value, including the Digital Thermal Sensor (DTS),
1111 * Package Thermal Management Sensor (PTM), and thermal event thresholds.
1113 static int __attribute__((warn_unused_result))
1114 set_temperature_target(struct thread_data *t, struct core_data *c, struct pkg_data *p)
1116 unsigned long long msr;
1117 unsigned int target_c_local;
1120 /* tcc_activation_temp is used only for dts or ptm */
1121 if (!(do_dts || do_ptm))
1124 /* this is a per-package concept */
1125 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) || !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
1129 if (cpu_migrate(cpu)) {
1130 ERROR("Could not migrate to CPU %d\n", cpu);
1131 return -ERR_CPU_MIGRATE;
1134 if (tcc_activation_temp_override != 0) {
1135 tcc_activation_temp = tcc_activation_temp_override;
1136 ERROR("cpu%d: Using cmdline TCC Target (%d C)\n",
1137 cpu, tcc_activation_temp);
1141 /* Temperature Target MSR is Nehalem and newer only */
1142 if (!do_nehalem_platform_info)
1145 if (get_msr(0, MSR_IA32_TEMPERATURE_TARGET, &msr))
1148 target_c_local = (msr >> 16) & 0x7F;
1150 if (target_c_local < 85 || target_c_local > 127)
1153 tcc_activation_temp = target_c_local;
1158 tcc_activation_temp = TJMAX_DEFAULT;
1159 WARNING("cpu%d: Guessing tjMax %d C, Please use -T to specify\n",
1160 cpu, tcc_activation_temp);
1165 static int __attribute__((warn_unused_result))
1168 unsigned int eax, ebx, ecx, edx, max_level;
1169 unsigned int fms, family, model;
1171 eax = ebx = ecx = edx = 0;
1173 __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
1175 if (ebx == 0x756e6547 && edx == 0x49656e69 && ecx == 0x6c65746e)
1179 __get_cpuid(1, &fms, &ebx, &ecx, &edx);
1180 family = (fms >> 8) & 0xf;
1181 model = (fms >> 4) & 0xf;
1182 if (family == 6 || family == 0xf)
1183 model += ((fms >> 16) & 0xf) << 4;
1185 if (!(edx & (1 << 5))) {
1186 ERROR("CPUID: no MSR");
1191 * check max extended function levels of CPUID.
1192 * This is needed to check for invariant TSC.
1193 * This check is valid for both Intel and AMD.
1195 ebx = ecx = edx = 0;
1196 __get_cpuid(0x80000000, &max_level, &ebx, &ecx, &edx);
1198 if (max_level < 0x80000007) {
1199 ERROR("CPUID: no invariant TSC (max_level 0x%x)", max_level);
1200 return -ERR_NO_INVARIANT_TSC;
1204 * Non-Stop TSC is advertised by CPUID.EAX=0x80000007: EDX.bit8
1205 * this check is valid for both Intel and AMD
1207 __get_cpuid(0x80000007, &eax, &ebx, &ecx, &edx);
1208 if (!(edx & (1 << 8))) {
1209 ERROR("No invariant TSC");
1210 return -ERR_NO_INVARIANT_TSC;
1214 * APERF/MPERF is advertised by CPUID.EAX=0x6: ECX.bit0
1215 * this check is valid for both Intel and AMD
1218 __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
1219 has_aperf = ecx & (1 << 0);
1220 do_dts = eax & (1 << 0);
1221 do_ptm = eax & (1 << 6);
1222 has_epb = ecx & (1 << 3);
1226 return -ERR_NO_APERF;
1229 do_nehalem_platform_info = genuine_intel;
1230 do_nhm_cstates = genuine_intel; /* all Intel w/ non-stop TSC have NHM counters */
1231 do_smi = do_nhm_cstates;
1232 do_snb_cstates = is_snb(family, model);
1233 do_c8_c9_c10 = has_c8_c9_c10(family, model);
1234 do_slm_cstates = is_slm(family, model);
1236 rapl_probe(family, model);
1243 static int __attribute__((warn_unused_result))
1248 int max_core_id = 0;
1249 int max_package_id = 0;
1250 int max_siblings = 0;
1251 struct cpu_topology {
1253 int physical_package_id;
1256 /* Initialize num_cpus, max_cpu_num */
1258 topo.max_cpu_num = 0;
1259 ret = for_all_proc_cpus(count_cpus);
1263 DEBUG("num_cpus %d max_cpu_num %d\n", topo.num_cpus, topo.max_cpu_num);
1265 cpus = calloc(1, (topo.max_cpu_num + 1) * sizeof(struct cpu_topology));
1267 ERROR("calloc cpus");
1272 * Allocate and initialize cpu_present_set
1274 cpu_present_set = CPU_ALLOC((topo.max_cpu_num + 1));
1275 if (cpu_present_set == NULL) {
1278 return -ERR_CPU_ALLOC;
1280 cpu_present_setsize = CPU_ALLOC_SIZE((topo.max_cpu_num + 1));
1281 CPU_ZERO_S(cpu_present_setsize, cpu_present_set);
1282 ret = for_all_proc_cpus(mark_cpu_present);
1289 * Allocate and initialize cpu_affinity_set
1291 cpu_affinity_set = CPU_ALLOC((topo.max_cpu_num + 1));
1292 if (cpu_affinity_set == NULL) {
1295 return -ERR_CPU_ALLOC;
1297 cpu_affinity_setsize = CPU_ALLOC_SIZE((topo.max_cpu_num + 1));
1298 CPU_ZERO_S(cpu_affinity_setsize, cpu_affinity_set);
1303 * find max_core_id, max_package_id
1305 for (i = 0; i <= topo.max_cpu_num; ++i) {
1308 if (cpu_is_not_present(i)) {
1310 fprintf(stderr, "cpu%d NOT PRESENT\n", i);
1313 cpus[i].core_id = get_core_id(i);
1314 if (cpus[i].core_id < 0)
1315 return cpus[i].core_id;
1316 if (cpus[i].core_id > max_core_id)
1317 max_core_id = cpus[i].core_id;
1319 cpus[i].physical_package_id = get_physical_package_id(i);
1320 if (cpus[i].physical_package_id < 0)
1321 return cpus[i].physical_package_id;
1322 if (cpus[i].physical_package_id > max_package_id)
1323 max_package_id = cpus[i].physical_package_id;
1325 siblings = get_num_ht_siblings(i);
1328 if (siblings > max_siblings)
1329 max_siblings = siblings;
1330 DEBUG("cpu %d pkg %d core %d\n",
1331 i, cpus[i].physical_package_id, cpus[i].core_id);
1333 topo.num_cores_per_pkg = max_core_id + 1;
1334 DEBUG("max_core_id %d, sizing for %d cores per package\n",
1335 max_core_id, topo.num_cores_per_pkg);
1337 topo.num_packages = max_package_id + 1;
1338 DEBUG("max_package_id %d, sizing for %d packages\n",
1339 max_package_id, topo.num_packages);
1341 topo.num_threads_per_core = max_siblings;
1342 DEBUG("max_siblings %d\n", max_siblings);
1349 allocate_counters(struct thread_data **t, struct core_data **c, struct pkg_data **p)
1353 *t = calloc(topo.num_threads_per_core * topo.num_cores_per_pkg *
1354 topo.num_packages, sizeof(struct thread_data));
1358 for (i = 0; i < topo.num_threads_per_core *
1359 topo.num_cores_per_pkg * topo.num_packages; i++)
1360 (*t)[i].cpu_id = -1;
1362 *c = calloc(topo.num_cores_per_pkg * topo.num_packages,
1363 sizeof(struct core_data));
1367 for (i = 0; i < topo.num_cores_per_pkg * topo.num_packages; i++)
1368 (*c)[i].core_id = -1;
1370 *p = calloc(topo.num_packages, sizeof(struct pkg_data));
1374 for (i = 0; i < topo.num_packages; i++)
1375 (*p)[i].package_id = i;
1379 ERROR("calloc counters");
1385 * set cpu_id, core_num, pkg_num
1386 * set FIRST_THREAD_IN_CORE and FIRST_CORE_IN_PACKAGE
1388 * increment topo.num_cores when 1st core in pkg seen
1391 init_counter(struct thread_data *thread_base, struct core_data *core_base,
1392 struct pkg_data *pkg_base, int thread_num, int core_num,
1393 int pkg_num, int cpu_id)
1396 struct thread_data *t;
1397 struct core_data *c;
1400 t = GET_THREAD(thread_base, thread_num, core_num, pkg_num);
1401 c = GET_CORE(core_base, core_num, pkg_num);
1402 p = GET_PKG(pkg_base, pkg_num);
1405 if (thread_num == 0) {
1406 t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1407 if ((ret = cpu_is_first_core_in_package(cpu_id)) < 0) {
1409 } else if (ret != 0) {
1410 t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1414 c->core_id = core_num;
1415 p->package_id = pkg_num;
1422 initialize_counters(int cpu_id)
1424 int my_thread_id, my_core_id, my_package_id;
1427 my_package_id = get_physical_package_id(cpu_id);
1428 if (my_package_id < 0)
1429 return my_package_id;
1430 my_core_id = get_core_id(cpu_id);
1434 if ((ret = cpu_is_first_sibling_in_core(cpu_id)) < 0) {
1436 } else if (ret != 0) {
1443 ret = init_counter(EVEN_COUNTERS, my_thread_id, my_core_id, my_package_id, cpu_id);
1446 ret = init_counter(ODD_COUNTERS, my_thread_id, my_core_id, my_package_id, cpu_id);
1452 #define DO_OR_GOTO_ERR(something) \
1454 ret = (something); \
1459 static int setup_all_buffers(void)
1463 DO_OR_GOTO_ERR(topology_probe());
1464 DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1465 DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1466 DO_OR_GOTO_ERR(for_all_proc_cpus(initialize_counters));
1476 turbostat_init(void)
1480 DO_OR_GOTO_ERR(check_cpuid());
1481 DO_OR_GOTO_ERR(check_dev_msr());
1482 DO_OR_GOTO_ERR(check_super_user());
1483 DO_OR_GOTO_ERR(setup_all_buffers());
1484 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1486 plugin_register_complex_read(NULL, PLUGIN_NAME, turbostat_read, NULL, NULL);
1494 void module_register(void);
1495 void module_register(void)
1497 plugin_register_init(PLUGIN_NAME, turbostat_init);