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_core_cstate;
67 static unsigned int do_pkg_cstate;
68 static unsigned int do_rapl;
69 static unsigned int do_dts;
70 static unsigned int do_ptm;
71 static unsigned int tcc_activation_temp;
72 static unsigned int tcc_activation_temp_override;
73 static double rapl_energy_units;
75 #define RAPL_PKG (1 << 0)
76 /* 0x610 MSR_PKG_POWER_LIMIT */
77 /* 0x611 MSR_PKG_ENERGY_STATUS */
78 #define RAPL_PKG_PERF_STATUS (1 << 1)
79 /* 0x613 MSR_PKG_PERF_STATUS */
80 #define RAPL_PKG_POWER_INFO (1 << 2)
81 /* 0x614 MSR_PKG_POWER_INFO */
83 #define RAPL_DRAM (1 << 3)
84 /* 0x618 MSR_DRAM_POWER_LIMIT */
85 /* 0x619 MSR_DRAM_ENERGY_STATUS */
86 /* 0x61c MSR_DRAM_POWER_INFO */
87 #define RAPL_DRAM_PERF_STATUS (1 << 4)
88 /* 0x61b MSR_DRAM_PERF_STATUS */
90 #define RAPL_CORES (1 << 5)
91 /* 0x638 MSR_PP0_POWER_LIMIT */
92 /* 0x639 MSR_PP0_ENERGY_STATUS */
93 #define RAPL_CORE_POLICY (1 << 6)
94 /* 0x63a MSR_PP0_POLICY */
97 #define RAPL_GFX (1 << 7)
98 /* 0x640 MSR_PP1_POWER_LIMIT */
99 /* 0x641 MSR_PP1_ENERGY_STATUS */
100 /* 0x642 MSR_PP1_POLICY */
101 #define TJMAX_DEFAULT 100
103 int aperf_mperf_unstable;
107 cpu_set_t *cpu_present_set, *cpu_affinity_set;
108 size_t cpu_present_setsize, cpu_affinity_setsize;
111 unsigned long long tsc;
112 unsigned long long aperf;
113 unsigned long long mperf;
114 unsigned long long c1;
115 unsigned int smi_count;
118 #define CPU_IS_FIRST_THREAD_IN_CORE 0x2
119 #define CPU_IS_FIRST_CORE_IN_PACKAGE 0x4
120 } *thread_even, *thread_odd;
123 unsigned long long c3;
124 unsigned long long c6;
125 unsigned long long c7;
126 unsigned int core_temp_c;
127 unsigned int core_id;
128 } *core_even, *core_odd;
131 unsigned long long pc2;
132 unsigned long long pc3;
133 unsigned long long pc6;
134 unsigned long long pc7;
135 unsigned long long pc8;
136 unsigned long long pc9;
137 unsigned long long pc10;
138 unsigned int package_id;
139 unsigned int energy_pkg; /* MSR_PKG_ENERGY_STATUS */
140 unsigned int energy_dram; /* MSR_DRAM_ENERGY_STATUS */
141 unsigned int energy_cores; /* MSR_PP0_ENERGY_STATUS */
142 unsigned int energy_gfx; /* MSR_PP1_ENERGY_STATUS */
143 unsigned int rapl_pkg_perf_status; /* MSR_PKG_PERF_STATUS */
144 unsigned int rapl_dram_perf_status; /* MSR_DRAM_PERF_STATUS */
145 unsigned int pkg_temp_c;
147 } *package_even, *package_odd;
149 #define ODD_COUNTERS thread_odd, core_odd, package_odd
150 #define EVEN_COUNTERS thread_even, core_even, package_even
151 static _Bool is_even = 1;
153 static _Bool allocated = 0;
154 static _Bool initialized = 0;
156 #define GET_THREAD(thread_base, thread_no, core_no, pkg_no) \
157 (thread_base + (pkg_no) * topo.num_cores_per_pkg * \
158 topo.num_threads_per_core + \
159 (core_no) * topo.num_threads_per_core + (thread_no))
160 #define GET_CORE(core_base, core_no, pkg_no) \
161 (core_base + (pkg_no) * topo.num_cores_per_pkg + (core_no))
162 #define GET_PKG(pkg_base, pkg_no) (pkg_base + pkg_no)
169 int num_cores_per_pkg;
170 int num_threads_per_core;
173 struct timeval tv_even, tv_odd, tv_delta;
181 ERR_MSR_CORE_C3_RESIDENCY,
182 ERR_MSR_CORE_C6_RESIDENCY,
183 ERR_MSR_CORE_C7_RESIDENCY,
184 ERR_MSR_IA32_THERM_STATUS,
185 ERR_MSR_PKG_C3_RESIDENCY,
186 ERR_MSR_PKG_C6_RESIDENCY,
187 ERR_MSR_PKG_C2_RESIDENCY,
188 ERR_MSR_PKG_C7_RESIDENCY,
189 ERR_MSR_PKG_C8_RESIDENCY,
190 ERR_MSR_PKG_C9_RESIDENCY,
191 ERR_MSR_PKG_C10_RESIDENCY,
192 ERR_MSR_PKG_ENERGY_STATUS,
193 ERR_MSR_PKG_POWER_INFO,
194 ERR_MSR_PP0_ENERGY_STATUS,
195 ERR_MSR_DRAM_ENERGY_STATUS,
196 ERR_MSR_PP1_ENERGY_STATUS,
197 ERR_MSR_PKG_PERF_STATUS,
198 ERR_MSR_DRAM_PERF_STATUS,
199 ERR_MSR_IA32_PACKAGE_THERM_STATUS,
205 ERR_CANT_READ_NUMBER,
206 ERR_CANT_READ_PROC_STAT,
207 ERR_NO_INVARIANT_TSC,
215 static int setup_all_buffers(void);
218 cpu_is_not_present(int cpu)
220 return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
223 * run func(thread, core, package) in topology order
224 * skip non-present cpus
227 static int __attribute__((warn_unused_result))
228 for_all_cpus(int (func)(struct thread_data *, struct core_data *, struct pkg_data *),
229 struct thread_data *thread_base, struct core_data *core_base, struct pkg_data *pkg_base)
231 int retval, pkg_no, core_no, thread_no;
233 for (pkg_no = 0; pkg_no < topo.num_packages; ++pkg_no) {
234 for (core_no = 0; core_no < topo.num_cores_per_pkg; ++core_no) {
235 for (thread_no = 0; thread_no <
236 topo.num_threads_per_core; ++thread_no) {
237 struct thread_data *t;
241 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
243 if (cpu_is_not_present(t->cpu_id))
246 c = GET_CORE(core_base, core_no, pkg_no);
247 p = GET_PKG(pkg_base, pkg_no);
249 retval = func(t, c, p);
258 static int __attribute__((warn_unused_result))
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 return -ERR_CPU_MIGRATE;
269 static int __attribute__((warn_unused_result))
274 ssnprintf(pathname, 32, "/dev/cpu/%d/msr", cpu);
275 return open(pathname, O_RDONLY);
278 static int __attribute__((warn_unused_result))
279 read_msr(int fd, off_t offset, unsigned long long *msr)
283 retval = pread(fd, msr, sizeof *msr, offset);
285 if (retval != sizeof *msr) {
286 ERROR ("MSR offset 0x%llx read failed", (unsigned long long)offset);
292 static int __attribute__((warn_unused_result))
293 get_msr(int cpu, off_t offset, unsigned long long *msr)
301 retval = read_msr(fd, offset, msr);
306 #define DELTA_WRAP32(new, old) \
310 old = 0x100000000 + new - old; \
314 delta_package(struct pkg_data *new, struct pkg_data *old)
316 old->pc2 = new->pc2 - old->pc2;
317 old->pc3 = new->pc3 - old->pc3;
318 old->pc6 = new->pc6 - old->pc6;
319 old->pc7 = new->pc7 - old->pc7;
320 old->pc8 = new->pc8 - old->pc8;
321 old->pc9 = new->pc9 - old->pc9;
322 old->pc10 = new->pc10 - old->pc10;
323 old->pkg_temp_c = new->pkg_temp_c;
325 DELTA_WRAP32(new->energy_pkg, old->energy_pkg);
326 DELTA_WRAP32(new->energy_cores, old->energy_cores);
327 DELTA_WRAP32(new->energy_gfx, old->energy_gfx);
328 DELTA_WRAP32(new->energy_dram, old->energy_dram);
329 DELTA_WRAP32(new->rapl_pkg_perf_status, old->rapl_pkg_perf_status);
330 DELTA_WRAP32(new->rapl_dram_perf_status, old->rapl_dram_perf_status);
334 delta_core(struct core_data *new, struct core_data *old)
336 old->c3 = new->c3 - old->c3;
337 old->c6 = new->c6 - old->c6;
338 old->c7 = new->c7 - old->c7;
339 old->core_temp_c = new->core_temp_c;
345 static int __attribute__((warn_unused_result))
346 delta_thread(struct thread_data *new, struct thread_data *old,
347 struct core_data *core_delta)
349 old->tsc = new->tsc - old->tsc;
351 /* check for TSC < 1 Mcycles over interval */
352 if (old->tsc < (1000 * 1000)) {
353 WARNING("Insanely slow TSC rate, TSC stops in idle?\n"
354 "You can disable all c-states by booting with \"idle=poll\"\n"
355 "or just the deep ones with \"processor.max_cstate=1\"");
359 old->c1 = new->c1 - old->c1;
361 if ((new->aperf > old->aperf) && (new->mperf > old->mperf)) {
362 old->aperf = new->aperf - old->aperf;
363 old->mperf = new->mperf - old->mperf;
366 if (!aperf_mperf_unstable) {
367 WARNING("%s: APERF or MPERF went backwards *\n", progname);
368 WARNING("* Frequency results do not cover entire interval *\n");
369 WARNING("* fix this by running Linux-2.6.30 or later *\n");
371 aperf_mperf_unstable = 1;
374 * mperf delta is likely a huge "positive" number
375 * can not use it for calculating c0 time
383 * As counter collection is not atomic,
384 * it is possible for mperf's non-halted cycles + idle states
385 * to exceed TSC's all cycles: show c1 = 0% in that case.
387 if ((old->mperf + core_delta->c3 + core_delta->c6 + core_delta->c7) > old->tsc)
390 /* normal case, derive c1 */
391 old->c1 = old->tsc - old->mperf - core_delta->c3
392 - core_delta->c6 - core_delta->c7;
395 if (old->mperf == 0) {
396 WARNING("cpu%d MPERF 0!\n", old->cpu_id);
397 old->mperf = 1; /* divide by 0 protection */
400 old->smi_count = new->smi_count - old->smi_count;
405 static int __attribute__((warn_unused_result))
406 delta_cpu(struct thread_data *t, struct core_data *c,
407 struct pkg_data *p, struct thread_data *t2,
408 struct core_data *c2, struct pkg_data *p2)
412 /* calculate core delta only for 1st thread in core */
413 if (t->flags & CPU_IS_FIRST_THREAD_IN_CORE)
416 /* always calculate thread delta */
417 ret = delta_thread(t, t2, c2); /* c2 is core delta */
421 /* calculate package delta only for 1st core in package */
422 if (t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)
423 delta_package(p, p2);
431 * acquire and record local counters for that cpu
433 static int __attribute__((warn_unused_result))
434 get_counters(struct thread_data *t, struct core_data *c, struct pkg_data *p)
437 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 msr_fd = open_msr(cpu);
448 return -ERR_CANT_OPEN_MSR;
450 #define READ_MSR(msr, dst) \
452 if (read_msr(msr_fd, msr, dst)) { \
453 retval = -ERR_##msr; \
458 READ_MSR(MSR_IA32_TSC, &t->tsc);
460 READ_MSR(MSR_IA32_APERF, &t->aperf);
461 READ_MSR(MSR_IA32_MPERF, &t->mperf);
463 READ_MSR(MSR_SMI_COUNT, &msr);
464 t->smi_count = msr & 0xFFFFFFFF;
466 /* collect core counters only for 1st thread in core */
467 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE)) {
472 if (do_core_cstate & (1 << 3))
473 READ_MSR(MSR_CORE_C3_RESIDENCY, &c->c3);
474 if (do_core_cstate & (1 << 6))
475 READ_MSR(MSR_CORE_C6_RESIDENCY, &c->c6);
476 if (do_core_cstate & (1 << 7))
477 READ_MSR(MSR_CORE_C7_RESIDENCY, &c->c7);
480 READ_MSR(MSR_IA32_THERM_STATUS, &msr);
481 c->core_temp_c = tcc_activation_temp - ((msr >> 16) & 0x7F);
484 /* collect package counters only for 1st core in package */
485 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE)) {
490 if (do_pkg_cstate & (1 << 2))
491 READ_MSR(MSR_PKG_C2_RESIDENCY, &p->pc2);
492 if (do_pkg_cstate & (1 << 3))
493 READ_MSR(MSR_PKG_C3_RESIDENCY, &p->pc3);
494 if (do_pkg_cstate & (1 << 6))
495 READ_MSR(MSR_PKG_C6_RESIDENCY, &p->pc6);
496 if (do_pkg_cstate & (1 << 7))
497 READ_MSR(MSR_PKG_C7_RESIDENCY, &p->pc7);
498 if (do_pkg_cstate & (1 << 8))
499 READ_MSR(MSR_PKG_C8_RESIDENCY, &p->pc8);
500 if (do_pkg_cstate & (1 << 9))
501 READ_MSR(MSR_PKG_C9_RESIDENCY, &p->pc9);
502 if (do_pkg_cstate & (1 << 10))
503 READ_MSR(MSR_PKG_C10_RESIDENCY, &p->pc10);
505 if (do_rapl & RAPL_PKG) {
506 READ_MSR(MSR_PKG_ENERGY_STATUS, &msr);
507 p->energy_pkg = msr & 0xFFFFFFFF;
509 if (do_rapl & RAPL_CORES) {
510 READ_MSR(MSR_PP0_ENERGY_STATUS, &msr);
511 p->energy_cores = msr & 0xFFFFFFFF;
513 if (do_rapl & RAPL_DRAM) {
514 READ_MSR(MSR_DRAM_ENERGY_STATUS, &msr);
515 p->energy_dram = msr & 0xFFFFFFFF;
517 if (do_rapl & RAPL_GFX) {
518 READ_MSR(MSR_PP1_ENERGY_STATUS, &msr);
519 p->energy_gfx = msr & 0xFFFFFFFF;
521 if (do_rapl & RAPL_PKG_PERF_STATUS) {
522 READ_MSR(MSR_PKG_PERF_STATUS, &msr);
523 p->rapl_pkg_perf_status = msr & 0xFFFFFFFF;
525 if (do_rapl & RAPL_DRAM_PERF_STATUS) {
526 READ_MSR(MSR_DRAM_PERF_STATUS, &msr);
527 p->rapl_dram_perf_status = msr & 0xFFFFFFFF;
530 READ_MSR(MSR_IA32_PACKAGE_THERM_STATUS, &msr);
531 p->pkg_temp_c = tcc_activation_temp - ((msr >> 16) & 0x7F);
540 free_all_buffers(void)
545 CPU_FREE(cpu_present_set);
546 cpu_present_set = NULL;
549 CPU_FREE(cpu_affinity_set);
550 cpu_affinity_set = NULL;
551 cpu_affinity_setsize = 0;
571 * Parse a file containing a single int.
573 static int __attribute__ ((format(printf,1,2)))
574 parse_int_file(const char *fmt, ...)
582 vsnprintf(path, sizeof(path), fmt, args);
584 filep = fopen(path, "r");
586 ERROR("%s: open failed", path);
587 return -ERR_CANT_OPEN_FILE;
589 if (fscanf(filep, "%d", &value) != 1) {
590 ERROR("%s: failed to parse number from file", path);
591 return -ERR_CANT_READ_NUMBER;
598 * cpu_is_first_sibling_in_core(cpu)
599 * return 1 if given CPU is 1st HT sibling in the core
602 cpu_is_first_sibling_in_core(int cpu)
604 return cpu == parse_int_file("/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
608 * cpu_is_first_core_in_package(cpu)
609 * return 1 if given CPU is 1st core in package
612 cpu_is_first_core_in_package(int cpu)
614 return cpu == parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", cpu);
618 get_physical_package_id(int cpu)
620 return parse_int_file("/sys/devices/system/cpu/cpu%d/topology/physical_package_id", cpu);
626 return parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", cpu);
630 get_num_ht_siblings(int cpu)
638 ssnprintf(path, 80, "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
639 filep = fopen(path, "r");
641 ERROR("%s: open failed", path);
642 return -ERR_CANT_OPEN_FILE;
646 * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
647 * otherwinse 1 sibling (self).
649 matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
660 * run func(thread, core, package) in topology order
661 * skip non-present cpus
665 static int __attribute__((warn_unused_result))
666 for_all_cpus_2(int (func)(struct thread_data *, struct core_data *,
667 struct pkg_data *, struct thread_data *, struct core_data *,
668 struct pkg_data *), struct thread_data *thread_base,
669 struct core_data *core_base, struct pkg_data *pkg_base,
670 struct thread_data *thread_base2, struct core_data *core_base2,
671 struct pkg_data *pkg_base2)
673 int retval, pkg_no, core_no, thread_no;
675 for (pkg_no = 0; pkg_no < topo.num_packages; ++pkg_no) {
676 for (core_no = 0; core_no < topo.num_cores_per_pkg; ++core_no) {
677 for (thread_no = 0; thread_no <
678 topo.num_threads_per_core; ++thread_no) {
679 struct thread_data *t, *t2;
680 struct core_data *c, *c2;
681 struct pkg_data *p, *p2;
683 t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
685 if (cpu_is_not_present(t->cpu_id))
688 t2 = GET_THREAD(thread_base2, thread_no, core_no, pkg_no);
690 c = GET_CORE(core_base, core_no, pkg_no);
691 c2 = GET_CORE(core_base2, core_no, pkg_no);
693 p = GET_PKG(pkg_base, pkg_no);
694 p2 = GET_PKG(pkg_base2, pkg_no);
696 retval = func(t, c, p, t2, c2, p2);
706 * run func(cpu) on every cpu in /proc/stat
707 * return max_cpu number
709 static int __attribute__((warn_unused_result))
710 for_all_proc_cpus(int (func)(int))
716 fp = fopen(proc_stat, "r");
718 ERROR("%s: open failed", proc_stat);
719 return -ERR_CANT_OPEN_FILE;
722 retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
724 ERROR("%s: failed to parse format", proc_stat);
725 return -ERR_CANT_READ_PROC_STAT;
729 retval = fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
733 retval = func(cpu_num);
745 * remember the last one seen, it will be the max
750 if (topo.max_cpu_num < cpu)
751 topo.max_cpu_num = cpu;
757 mark_cpu_present(int cpu)
759 CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
765 turbostat_submit (const char *plugin_instance,
766 const char *type, const char *type_instance,
769 value_list_t vl = VALUE_LIST_INIT;
775 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
776 sstrncpy (vl.plugin, PLUGIN_NAME, sizeof (vl.plugin));
777 if (plugin_instance != NULL)
778 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
779 sstrncpy (vl.type, type, sizeof (vl.type));
780 if (type_instance != NULL)
781 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
783 plugin_dispatch_values (&vl);
787 * column formatting convention & formats
788 * package: "pk" 2 columns %2d
789 * core: "cor" 3 columns %3d
790 * CPU: "CPU" 3 columns %3d
795 * GHz: "GHz" 3 columns %3.2
796 * TSC: "TSC" 3 columns %3.2
797 * SMI: "SMI" 4 columns %4d
798 * percentage " %pc3" %6.2
799 * Perf Status percentage: %5.2
800 * "CTMP" 4 columns %4d
804 submit_counters(struct thread_data *t, struct core_data *c,
808 double interval_float;
810 interval_float = tv_delta.tv_sec + tv_delta.tv_usec/1000000.0;
812 snprintf(name, NAME_LEN, "cpu%02d", t->cpu_id);
815 turbostat_submit(name, "percent", "c0", 100.0 * t->mperf/t->tsc);
817 turbostat_submit(name, "percent", "c1", 100.0 * t->c1/t->tsc);
820 if ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc)))
821 turbostat_submit(NULL, "frequency", name, 1.0 * t->tsc / 1000000000 * t->aperf / t->mperf / interval_float);
824 turbostat_submit(NULL, "current", name, t->smi_count);
826 /* print per-core data only for 1st thread in core */
827 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE))
830 snprintf(name, NAME_LEN, "core%02d", c->core_id);
832 if (do_core_cstate & (1 << 3))
833 turbostat_submit(name, "percent", "c3", 100.0 * c->c3/t->tsc);
834 if (do_core_cstate & (1 << 6))
835 turbostat_submit(name, "percent", "c6", 100.0 * c->c6/t->tsc);
836 if (do_core_cstate & (1 << 7))
837 turbostat_submit(name, "percent", "c7", 100.0 * c->c7/t->tsc);
840 turbostat_submit(NULL, "temperature", name, c->core_temp_c);
842 /* print per-package data only for 1st core in package */
843 if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
846 snprintf(name, NAME_LEN, "pkg%02d", p->package_id);
849 turbostat_submit(NULL, "temperature", name, p->pkg_temp_c);
851 if (do_pkg_cstate & (1 << 2))
852 turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2/t->tsc);
853 if (do_pkg_cstate & (1 << 3))
854 turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3/t->tsc);
855 if (do_pkg_cstate & (1 << 6))
856 turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6/t->tsc);
857 if (do_pkg_cstate & (1 << 7))
858 turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7/t->tsc);
859 if (do_pkg_cstate & (1 << 8))
860 turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8/t->tsc);
861 if (do_pkg_cstate & (1 << 9))
862 turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9/t->tsc);
863 if (do_pkg_cstate & (1 << 10))
864 turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10/t->tsc);
867 if (do_rapl & RAPL_PKG)
868 turbostat_submit(name, "power", "Pkg_W", p->energy_pkg * rapl_energy_units / interval_float);
869 if (do_rapl & RAPL_CORES)
870 turbostat_submit(name, "power", "Cor_W", p->energy_cores * rapl_energy_units / interval_float);
871 if (do_rapl & RAPL_GFX)
872 turbostat_submit(name, "power", "GFX_W", p->energy_gfx * rapl_energy_units / interval_float);
873 if (do_rapl & RAPL_DRAM)
874 turbostat_submit(name, "power", "RAM_W", p->energy_dram * rapl_energy_units / interval_float);
881 turbostat_read(user_data_t * not_used)
886 if ((ret = setup_all_buffers()) < 0)
890 if (for_all_proc_cpus(cpu_is_not_present)) {
892 if ((ret = setup_all_buffers()) < 0)
894 if (for_all_proc_cpus(cpu_is_not_present))
895 return -ERR_CPU_NOT_PRESENT;
899 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
901 gettimeofday(&tv_even, (struct timezone *)NULL);
908 if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
910 gettimeofday(&tv_odd, (struct timezone *)NULL);
912 timersub(&tv_odd, &tv_even, &tv_delta);
913 if ((ret = for_all_cpus_2(delta_cpu, ODD_COUNTERS, EVEN_COUNTERS)) < 0)
915 if ((ret = for_all_cpus(submit_counters, EVEN_COUNTERS)) < 0)
918 if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
920 gettimeofday(&tv_even, (struct timezone *)NULL);
922 timersub(&tv_even, &tv_odd, &tv_delta);
923 if ((ret = for_all_cpus_2(delta_cpu, EVEN_COUNTERS, ODD_COUNTERS)) < 0)
925 if ((ret = for_all_cpus(submit_counters, ODD_COUNTERS)) < 0)
931 static int __attribute__((warn_unused_result))
936 if (stat("/dev/cpu/0/msr", &sb)) {
937 ERROR("no /dev/cpu/0/msr\n"
938 "Try \"# modprobe msr\"");
944 static int __attribute__((warn_unused_result))
948 ERROR("must be root");
949 return -ERR_NOT_ROOT;
955 * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
956 * the Thermal Control Circuit (TCC) activates.
957 * This is usually equal to tjMax.
959 * Older processors do not have this MSR, so there we guess,
960 * but also allow cmdline over-ride with -T.
962 * Several MSR temperature values are in units of degrees-C
963 * below this value, including the Digital Thermal Sensor (DTS),
964 * Package Thermal Management Sensor (PTM), and thermal event thresholds.
966 static int __attribute__((warn_unused_result))
967 set_temperature_target(struct thread_data *t, struct core_data *c, struct pkg_data *p)
969 unsigned long long msr;
970 unsigned int target_c_local;
973 /* tcc_activation_temp is used only for dts or ptm */
974 if (!(do_dts || do_ptm))
977 /* this is a per-package concept */
978 if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) || !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
982 if (cpu_migrate(cpu)) {
983 ERROR("Could not migrate to CPU %d\n", cpu);
984 return -ERR_CPU_MIGRATE;
987 if (tcc_activation_temp_override != 0) {
988 tcc_activation_temp = tcc_activation_temp_override;
989 ERROR("cpu%d: Using cmdline TCC Target (%d C)\n",
990 cpu, tcc_activation_temp);
994 if (get_msr(0, MSR_IA32_TEMPERATURE_TARGET, &msr))
997 target_c_local = (msr >> 16) & 0x7F;
999 if (target_c_local < 85 || target_c_local > 127)
1002 tcc_activation_temp = target_c_local;
1007 tcc_activation_temp = TJMAX_DEFAULT;
1008 WARNING("cpu%d: Guessing tjMax %d C, Please use -T to specify\n",
1009 cpu, tcc_activation_temp);
1015 * Identify the functionality of the CPU
1017 static int __attribute__((warn_unused_result))
1020 unsigned int eax, ebx, ecx, edx, max_level;
1021 unsigned int fms, family, model;
1024 * - EAX: Maximum Input Value for Basic CPUID Information
1025 * - EBX: "Genu" (0x756e6547)
1026 * - EDX: "ineI" (0x49656e69)
1027 * - ECX: "ntel" (0x6c65746e)
1029 max_level = ebx = ecx = edx = 0;
1030 __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
1031 if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
1032 ERROR("Unsupported CPU");
1033 return -UNSUPPORTED_CPU;
1037 * - EAX: Version Information: Type, Family, Model, and Stepping ID
1040 * + 12-13: Processor type
1041 * + 16-19: Extended Model ID
1042 * + 20-27: Extended Family ID
1043 * - EDX: Feature Information:
1044 * + 5: Support for MSR read/write operations
1046 fms = ebx = ecx = edx = 0;
1047 __get_cpuid(1, &fms, &ebx, &ecx, &edx);
1048 family = (fms >> 8) & 0xf;
1049 model = (fms >> 4) & 0xf;
1051 family += (fms >> 20) & 0xf;
1052 if (family == 6 || family == 0xf)
1053 model += ((fms >> 16) & 0xf) << 4;
1054 if (!(edx & (1 << 5))) {
1055 ERROR("CPUID: no MSR");
1060 * CPUID(0x80000000):
1061 * - EAX: Maximum Input Value for Extended Function CPUID Information
1063 * This allows us to verify if the CPUID(0x80000007) can be called
1065 * This check is valid for both Intel and AMD.
1067 max_level = ebx = ecx = edx = 0;
1068 __get_cpuid(0x80000000, &max_level, &ebx, &ecx, &edx);
1069 if (max_level < 0x80000007) {
1070 ERROR("CPUID: no invariant TSC (max_level 0x%x)", max_level);
1071 return -ERR_NO_INVARIANT_TSC;
1075 * CPUID(0x80000007):
1077 * + 8: Invariant TSC available if set
1079 * This check is valid for both Intel and AMD
1081 __get_cpuid(0x80000007, &eax, &ebx, &ecx, &edx);
1082 if (!(edx & (1 << 8))) {
1083 ERROR("No invariant TSC");
1084 return -ERR_NO_INVARIANT_TSC;
1090 * + 0: Digital temperature sensor is supported if set
1091 * + 6: Package thermal management is supported if set
1093 * + 0: Hardware Coordination Feedback Capability (Presence of IA32_MPERF and IA32_APERF).
1094 * + 3: The processor supports performance-energy bias preference if set.
1095 * It also implies the presence of a new architectural MSR called IA32_ENERGY_PERF_BIAS
1097 * This check is valid for both Intel and AMD
1099 __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
1100 do_dts = eax & (1 << 0);
1101 do_ptm = eax & (1 << 6);
1102 if (!(ecx & (1 << 0))) {
1104 return -ERR_NO_APERF;
1108 * Enable or disable C states depending on the model and family
1112 /* Atom (partial) */
1115 do_pkg_cstate = (1 << 2) | (1 << 4) | (1 << 6);
1118 case 0x37: /* BYT */
1120 case 0x4D: /* AVN */
1123 do_core_cstate = (1 << 1) | (1 << 6);
1124 do_pkg_cstate = (1 << 6);
1127 case 0x1A: /* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
1128 case 0x1E: /* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper Forest */
1129 case 0x1F: /* Core i7 and i5 Processor - Nehalem */
1130 case 0x2E: /* Nehalem-EX Xeon - Beckton */
1131 do_core_cstate = (1 << 3) | (1 << 6);
1132 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1135 case 0x25: /* Westmere Client - Clarkdale, Arrandale */
1136 case 0x2C: /* Westmere EP - Gulftown */
1137 case 0x2F: /* Westmere-EX Xeon - Eagleton */
1138 do_core_cstate = (1 << 3) | (1 << 6);
1139 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1142 case 0x2A: /* SNB */
1143 case 0x2D: /* SNB Xeon */
1144 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1145 do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
1148 case 0x3A: /* IVB */
1149 case 0x3E: /* IVB Xeon */
1150 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1151 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1153 /* Haswell Bridge */
1154 case 0x3C: /* HSW */
1155 case 0x3F: /* HSW */
1156 case 0x46: /* HSW */
1157 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1158 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1160 case 0x45: /* HSW */
1161 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1162 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9) | (1 << 10);
1165 case 0x4F: /* BDW */
1166 case 0x56: /* BDX-DE */
1167 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1168 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1170 case 0x3D: /* BDW */
1171 do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
1172 do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9) | (1 << 10);
1175 ERROR("Unsupported CPU");
1183 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_CORE_POLICY | RAPL_PKG_POWER_INFO | RAPL_GFX;
1186 do_rapl = RAPL_PKG | RAPL_PKG_POWER_INFO | RAPL_PKG_PERF_STATUS | RAPL_DRAM | RAPL_DRAM_PERF_STATUS;
1190 do_rapl = RAPL_PKG | RAPL_CORES | RAPL_CORE_POLICY | RAPL_PKG_POWER_INFO | RAPL_PKG_PERF_STATUS | RAPL_DRAM | RAPL_DRAM_PERF_STATUS;
1194 do_rapl = RAPL_PKG | RAPL_CORES;
1200 ERROR("Unsupported CPU");
1201 return -UNSUPPORTED_CPU;
1206 if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1210 rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1212 rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1220 static int __attribute__((warn_unused_result))
1225 int max_core_id = 0;
1226 int max_package_id = 0;
1227 int max_siblings = 0;
1228 struct cpu_topology {
1230 int physical_package_id;
1233 /* Initialize num_cpus, max_cpu_num */
1235 topo.max_cpu_num = 0;
1236 ret = for_all_proc_cpus(count_cpus);
1240 DEBUG("num_cpus %d max_cpu_num %d\n", topo.num_cpus, topo.max_cpu_num);
1242 cpus = calloc(1, (topo.max_cpu_num + 1) * sizeof(struct cpu_topology));
1244 ERROR("calloc cpus");
1249 * Allocate and initialize cpu_present_set
1251 cpu_present_set = CPU_ALLOC((topo.max_cpu_num + 1));
1252 if (cpu_present_set == NULL) {
1255 return -ERR_CPU_ALLOC;
1257 cpu_present_setsize = CPU_ALLOC_SIZE((topo.max_cpu_num + 1));
1258 CPU_ZERO_S(cpu_present_setsize, cpu_present_set);
1259 ret = for_all_proc_cpus(mark_cpu_present);
1266 * Allocate and initialize cpu_affinity_set
1268 cpu_affinity_set = CPU_ALLOC((topo.max_cpu_num + 1));
1269 if (cpu_affinity_set == NULL) {
1272 return -ERR_CPU_ALLOC;
1274 cpu_affinity_setsize = CPU_ALLOC_SIZE((topo.max_cpu_num + 1));
1275 CPU_ZERO_S(cpu_affinity_setsize, cpu_affinity_set);
1280 * find max_core_id, max_package_id
1282 for (i = 0; i <= topo.max_cpu_num; ++i) {
1285 if (cpu_is_not_present(i)) {
1287 fprintf(stderr, "cpu%d NOT PRESENT\n", i);
1290 cpus[i].core_id = get_core_id(i);
1291 if (cpus[i].core_id < 0)
1292 return cpus[i].core_id;
1293 if (cpus[i].core_id > max_core_id)
1294 max_core_id = cpus[i].core_id;
1296 cpus[i].physical_package_id = get_physical_package_id(i);
1297 if (cpus[i].physical_package_id < 0)
1298 return cpus[i].physical_package_id;
1299 if (cpus[i].physical_package_id > max_package_id)
1300 max_package_id = cpus[i].physical_package_id;
1302 siblings = get_num_ht_siblings(i);
1305 if (siblings > max_siblings)
1306 max_siblings = siblings;
1307 DEBUG("cpu %d pkg %d core %d\n",
1308 i, cpus[i].physical_package_id, cpus[i].core_id);
1310 topo.num_cores_per_pkg = max_core_id + 1;
1311 DEBUG("max_core_id %d, sizing for %d cores per package\n",
1312 max_core_id, topo.num_cores_per_pkg);
1314 topo.num_packages = max_package_id + 1;
1315 DEBUG("max_package_id %d, sizing for %d packages\n",
1316 max_package_id, topo.num_packages);
1318 topo.num_threads_per_core = max_siblings;
1319 DEBUG("max_siblings %d\n", max_siblings);
1326 allocate_counters(struct thread_data **t, struct core_data **c, struct pkg_data **p)
1330 *t = calloc(topo.num_threads_per_core * topo.num_cores_per_pkg *
1331 topo.num_packages, sizeof(struct thread_data));
1335 for (i = 0; i < topo.num_threads_per_core *
1336 topo.num_cores_per_pkg * topo.num_packages; i++)
1337 (*t)[i].cpu_id = -1;
1339 *c = calloc(topo.num_cores_per_pkg * topo.num_packages,
1340 sizeof(struct core_data));
1344 for (i = 0; i < topo.num_cores_per_pkg * topo.num_packages; i++)
1345 (*c)[i].core_id = -1;
1347 *p = calloc(topo.num_packages, sizeof(struct pkg_data));
1351 for (i = 0; i < topo.num_packages; i++)
1352 (*p)[i].package_id = i;
1356 ERROR("calloc counters");
1362 * set cpu_id, core_num, pkg_num
1363 * set FIRST_THREAD_IN_CORE and FIRST_CORE_IN_PACKAGE
1365 * increment topo.num_cores when 1st core in pkg seen
1368 init_counter(struct thread_data *thread_base, struct core_data *core_base,
1369 struct pkg_data *pkg_base, int thread_num, int core_num,
1370 int pkg_num, int cpu_id)
1373 struct thread_data *t;
1374 struct core_data *c;
1377 t = GET_THREAD(thread_base, thread_num, core_num, pkg_num);
1378 c = GET_CORE(core_base, core_num, pkg_num);
1379 p = GET_PKG(pkg_base, pkg_num);
1382 if (thread_num == 0) {
1383 t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1384 if ((ret = cpu_is_first_core_in_package(cpu_id)) < 0) {
1386 } else if (ret != 0) {
1387 t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1391 c->core_id = core_num;
1392 p->package_id = pkg_num;
1399 initialize_counters(int cpu_id)
1401 int my_thread_id, my_core_id, my_package_id;
1404 my_package_id = get_physical_package_id(cpu_id);
1405 if (my_package_id < 0)
1406 return my_package_id;
1407 my_core_id = get_core_id(cpu_id);
1411 if ((ret = cpu_is_first_sibling_in_core(cpu_id)) < 0) {
1413 } else if (ret != 0) {
1420 ret = init_counter(EVEN_COUNTERS, my_thread_id, my_core_id, my_package_id, cpu_id);
1423 ret = init_counter(ODD_COUNTERS, my_thread_id, my_core_id, my_package_id, cpu_id);
1429 #define DO_OR_GOTO_ERR(something) \
1431 ret = (something); \
1436 static int setup_all_buffers(void)
1440 DO_OR_GOTO_ERR(topology_probe());
1441 DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1442 DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1443 DO_OR_GOTO_ERR(for_all_proc_cpus(initialize_counters));
1453 turbostat_init(void)
1457 DO_OR_GOTO_ERR(check_super_user());
1458 DO_OR_GOTO_ERR(probe_cpu());
1459 DO_OR_GOTO_ERR(check_dev_msr());
1460 DO_OR_GOTO_ERR(setup_all_buffers());
1461 DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1463 plugin_register_complex_read(NULL, PLUGIN_NAME, turbostat_read, NULL, NULL);
1471 void module_register(void);
1472 void module_register(void)
1474 plugin_register_init(PLUGIN_NAME, turbostat_init);