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   snprintf(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   snprintf(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",
 571                      1.0 * t->tsc / 1000000 * 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     if (topology.num_packages > 1)
 589       snprintf(name, sizeof(name), "pkg%02d-core%02d", p->package_id, c->core_id);
 590     else
 591       snprintf(name, sizeof(name), "core%02d", c->core_id);
 592   }
 593
 594   if (do_core_cstate & (1 << 3))
 595     turbostat_submit(name, "percent", "c3", 100.0 * c->c3 / t->tsc);
 596   if (do_core_cstate & (1 << 6))
 597     turbostat_submit(name, "percent", "c6", 100.0 * c->c6 / t->tsc);
 598   if (do_core_cstate & (1 << 7))
 599     turbostat_submit(name, "percent", "c7", 100.0 * c->c7 / t->tsc);
 600
 601   if (do_dts)
 602     turbostat_submit(name, "temperature", NULL, c->core_temp_c);
 603
 604   /* submit per-package data only for 1st core in package */
 605   if (!(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
 606     goto done;
 607
 608   snprintf(name, sizeof(name), "pkg%02d", p->package_id);
 609
 610   if (do_ptm)
 611     turbostat_submit(name, "temperature", NULL, p->pkg_temp_c);
 612
 613   if (do_pkg_cstate & (1 << 2))
 614     turbostat_submit(name, "percent", "pc2", 100.0 * p->pc2 / t->tsc);
 615   if (do_pkg_cstate & (1 << 3))
 616     turbostat_submit(name, "percent", "pc3", 100.0 * p->pc3 / t->tsc);
 617   if (do_pkg_cstate & (1 << 6))
 618     turbostat_submit(name, "percent", "pc6", 100.0 * p->pc6 / t->tsc);
 619   if (do_pkg_cstate & (1 << 7))
 620     turbostat_submit(name, "percent", "pc7", 100.0 * p->pc7 / t->tsc);
 621   if (do_pkg_cstate & (1 << 8))
 622     turbostat_submit(name, "percent", "pc8", 100.0 * p->pc8 / t->tsc);
 623   if (do_pkg_cstate & (1 << 9))
 624     turbostat_submit(name, "percent", "pc9", 100.0 * p->pc9 / t->tsc);
 625   if (do_pkg_cstate & (1 << 10))
 626     turbostat_submit(name, "percent", "pc10", 100.0 * p->pc10 / t->tsc);
 627
 628   if (do_rapl) {
 629     if (do_rapl & RAPL_PKG)
 630       turbostat_submit(name, "power", "pkg",
 631                        p->energy_pkg * rapl_energy_units / interval_float);
 632     if (do_rapl & RAPL_CORES)
 633       turbostat_submit(name, "power", "cores",
 634                        p->energy_cores * rapl_energy_units / interval_float);
 635     if (do_rapl & RAPL_GFX)
 636       turbostat_submit(name, "power", "GFX",
 637                        p->energy_gfx * rapl_energy_units / interval_float);
 638     if (do_rapl & RAPL_DRAM)
 639       turbostat_submit(name, "power", "DRAM",
 640                        p->energy_dram * rapl_energy_units / interval_float);
 641   }
 642 done:
 643   return 0;
 644 }
 645
 646 /**********************************
 647  * Looping function over all CPUs *
 648  **********************************/
 649
 650 /*
 651  * Check if a given cpu id is in our compiled list of existing CPUs
 652  */
 653 static int cpu_is_not_present(unsigned int cpu) {
 654   return !CPU_ISSET_S(cpu, cpu_present_setsize, cpu_present_set);
 655 }
 656
 657 /*
 658  * Loop on all CPUs in topological order
 659  *
 660  * Skip non-present cpus
 661  * Return the error code at the first error or 0
 662  */
 663 static int __attribute__((warn_unused_result))
 664 for_all_cpus(int(func)(struct thread_data *, struct core_data *,
 665                        struct pkg_data *),
 666              struct thread_data *thread_base, struct core_data *core_base,
 667              struct pkg_data *pkg_base) {
 668   int retval;
 669
 670   for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
 671     for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
 672       for (unsigned int thread_no = 0; thread_no < topology.num_threads;
 673            ++thread_no) {
 674         struct thread_data *t;
 675         struct core_data *c;
 676         struct pkg_data *p;
 677
 678         t = GET_THREAD(thread_base, thread_no, core_no, pkg_no);
 679
 680         if (cpu_is_not_present(t->cpu_id))
 681           continue;
 682
 683         c = GET_CORE(core_base, core_no, pkg_no);
 684         p = GET_PKG(pkg_base, pkg_no);
 685
 686         retval = func(t, c, p);
 687         if (retval)
 688           return retval;
 689       }
 690     }
 691   }
 692   return 0;
 693 }
 694
 695 /*
 696  * Dedicated loop: Extract every data evolution for all CPU
 697  *
 698  * Skip non-present cpus
 699  * Return the error code at the first error or 0
 700  *
 701  * Core data is shared for all threads in one core: extracted only for the first
 702  * thread
 703  * Package data is shared for all core in one package: extracted only for the
 704  * first thread of the first core
 705  */
 706 static int __attribute__((warn_unused_result))
 707 for_all_cpus_delta(const struct thread_data *thread_new_base,
 708                    const struct core_data *core_new_base,
 709                    const struct pkg_data *pkg_new_base,
 710                    const struct thread_data *thread_old_base,
 711                    const struct core_data *core_old_base,
 712                    const struct pkg_data *pkg_old_base) {
 713   int retval;
 714
 715   for (unsigned int pkg_no = 0; pkg_no < topology.num_packages; ++pkg_no) {
 716     for (unsigned int core_no = 0; core_no < topology.num_cores; ++core_no) {
 717       for (unsigned int thread_no = 0; thread_no < topology.num_threads;
 718            ++thread_no) {
 719         struct thread_data *t_delta;
 720         const struct thread_data *t_old, *t_new;
 721         struct core_data *c_delta;
 722
 723         /* Get correct pointers for threads */
 724         t_delta = GET_THREAD(thread_delta, thread_no, core_no, pkg_no);
 725         t_new = GET_THREAD(thread_new_base, thread_no, core_no, pkg_no);
 726         t_old = GET_THREAD(thread_old_base, thread_no, core_no, pkg_no);
 727
 728         /* Skip threads that disappeared */
 729         if (cpu_is_not_present(t_delta->cpu_id))
 730           continue;
 731
 732         /* c_delta is always required for delta_thread */
 733         c_delta = GET_CORE(core_delta, core_no, pkg_no);
 734
 735         /* calculate core delta only for 1st thread in core */
 736         if (t_new->flags & CPU_IS_FIRST_THREAD_IN_CORE) {
 737           const struct core_data *c_old, *c_new;
 738
 739           c_new = GET_CORE(core_new_base, core_no, pkg_no);
 740           c_old = GET_CORE(core_old_base, core_no, pkg_no);
 741
 742           delta_core(c_delta, c_new, c_old);
 743         }
 744
 745         /* Always calculate thread delta */
 746         retval = delta_thread(t_delta, t_new, t_old, c_delta);
 747         if (retval)
 748           return retval;
 749
 750         /* calculate package delta only for 1st core in package */
 751         if (t_new->flags & CPU_IS_FIRST_CORE_IN_PACKAGE) {
 752           struct pkg_data *p_delta;
 753           const struct pkg_data *p_old, *p_new;
 754
 755           p_delta = GET_PKG(package_delta, pkg_no);
 756           p_new = GET_PKG(pkg_new_base, pkg_no);
 757           p_old = GET_PKG(pkg_old_base, pkg_no);
 758
 759           delta_package(p_delta, p_new, p_old);
 760         }
 761       }
 762     }
 763   }
 764   return 0;
 765 }
 766
 767 /***************
 768  * CPU Probing *
 769  ***************/
 770
 771 /*
 772  * MSR_IA32_TEMPERATURE_TARGET indicates the temperature where
 773  * the Thermal Control Circuit (TCC) activates.
 774  * This is usually equal to tjMax.
 775  *
 776  * Older processors do not have this MSR, so there we guess,
 777  * but also allow conficuration over-ride with "TCCActivationTemp".
 778  *
 779  * Several MSR temperature values are in units of degrees-C
 780  * below this value, including the Digital Thermal Sensor (DTS),
 781  * Package Thermal Management Sensor (PTM), and thermal event thresholds.
 782  */
 783 static int __attribute__((warn_unused_result))
 784 set_temperature_target(struct thread_data *t, struct core_data *c,
 785                        struct pkg_data *p) {
 786   unsigned long long msr;
 787   unsigned int target_c_local;
 788
 789   /* tcc_activation_temp is used only for dts or ptm */
 790   if (!(do_dts || do_ptm))
 791     return 0;
 792
 793   /* this is a per-package concept */
 794   if (!(t->flags & CPU_IS_FIRST_THREAD_IN_CORE) ||
 795       !(t->flags & CPU_IS_FIRST_CORE_IN_PACKAGE))
 796     return 0;
 797
 798   if (tcc_activation_temp != 0) {
 799     p->tcc_activation_temp = tcc_activation_temp;
 800     return 0;
 801   }
 802
 803   if (get_msr(t->cpu_id, MSR_IA32_TEMPERATURE_TARGET, &msr))
 804     goto guess;
 805
 806   target_c_local = (msr >> 16) & 0xFF;
 807
 808   if (!target_c_local)
 809     goto guess;
 810
 811   p->tcc_activation_temp = target_c_local;
 812
 813   return 0;
 814
 815 guess:
 816   p->tcc_activation_temp = TJMAX_DEFAULT;
 817   WARNING("turbostat plugin: cpu%d: Guessing tjMax %d C,"
 818           " Please use TCCActivationTemp to specify it.",
 819           t->cpu_id, p->tcc_activation_temp);
 820
 821   return 0;
 822 }
 823
 824 /*
 825  * Identify the functionality of the CPU
 826  */
 827 static int __attribute__((warn_unused_result)) probe_cpu(void) {
 828   unsigned int eax, ebx, ecx, edx, max_level;
 829   unsigned int fms, family, model;
 830
 831   /* CPUID(0):
 832    * - EAX: Maximum Input Value for Basic CPUID Information
 833    * - EBX: "Genu" (0x756e6547)
 834    * - EDX: "ineI" (0x49656e69)
 835    * - ECX: "ntel" (0x6c65746e)
 836    */
 837   max_level = ebx = ecx = edx = 0;
 838   __get_cpuid(0, &max_level, &ebx, &ecx, &edx);
 839   if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
 840     ERROR("turbostat plugin: Unsupported CPU (not Intel)");
 841     return -1;
 842   }
 843
 844   /* CPUID(1):
 845    * - EAX: Version Information: Type, Family, Model, and Stepping ID
 846    *  + 4-7:   Model ID
 847    *  + 8-11:  Family ID
 848    *  + 12-13: Processor type
 849    *  + 16-19: Extended Model ID
 850    *  + 20-27: Extended Family ID
 851    * - EDX: Feature Information:
 852    *  + 5: Support for MSR read/write operations
 853    */
 854   fms = ebx = ecx = edx = 0;
 855   __get_cpuid(1, &fms, &ebx, &ecx, &edx);
 856   family = (fms >> 8) & 0xf;
 857   model = (fms >> 4) & 0xf;
 858   if (family == 0xf)
 859     family += (fms >> 20) & 0xf;
 860   if (family == 6 || family == 0xf)
 861     model += ((fms >> 16) & 0xf) << 4;
 862   if (!(edx & (1 << 5))) {
 863     ERROR("turbostat plugin: Unsupported CPU (no MSR support)");
 864     return -1;
 865   }
 866
 867   /*
 868    * CPUID(6):
 869    * - EAX:
 870    *  + 0: Digital temperature sensor is supported if set
 871    *  + 6: Package thermal management is supported if set
 872    * - ECX:
 873    *  + 0: Hardware Coordination Feedback Capability (Presence of IA32_MPERF and
 874    * IA32_APERF).
 875    *  + 3: The processor supports performance-energy bias preference if set.
 876    *       It also implies the presence of a new architectural MSR called
 877    * IA32_ENERGY_PERF_BIAS
 878    *
 879    * This check is valid for both Intel and AMD
 880    */
 881   eax = ebx = ecx = edx = 0;
 882   __get_cpuid(0x6, &eax, &ebx, &ecx, &edx);
 883   do_dts = eax & (1 << 0);
 884   do_ptm = eax & (1 << 6);
 885   if (!(ecx & (1 << 0))) {
 886     ERROR("turbostat plugin: Unsupported CPU (No APERF)");
 887     return -1;
 888   }
 889
 890   /*
 891    * Enable or disable C states depending on the model and family
 892    */
 893   if (family == 6) {
 894     switch (model) {
 895     /* Atom (partial) */
 896     case 0x27:
 897       do_smi = 0;
 898       do_core_cstate = 0;
 899       do_pkg_cstate = (1 << 2) | (1 << 4) | (1 << 6);
 900       break;
 901     /* Silvermont */
 902     case 0x37: /* BYT */
 903     case 0x4D: /* AVN */
 904       do_smi = 1;
 905       do_core_cstate = (1 << 1) | (1 << 6);
 906       do_pkg_cstate = (1 << 6);
 907       break;
 908     /* Nehalem */
 909     case 0x1A: /* Core i7, Xeon 5500 series - Bloomfield, Gainstown NHM-EP */
 910     case 0x1E: /* Core i7 and i5 Processor - Clarksfield, Lynnfield, Jasper
 911                   Forest */
 912     case 0x1F: /* Core i7 and i5 Processor - Nehalem */
 913     case 0x2E: /* Nehalem-EX Xeon - Beckton */
 914       do_smi = 1;
 915       do_core_cstate = (1 << 3) | (1 << 6);
 916       do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 917       break;
 918     /* Westmere */
 919     case 0x25: /* Westmere Client - Clarkdale, Arrandale */
 920     case 0x2C: /* Westmere EP - Gulftown */
 921     case 0x2F: /* Westmere-EX Xeon - Eagleton */
 922       do_smi = 1;
 923       do_core_cstate = (1 << 3) | (1 << 6);
 924       do_pkg_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 925       break;
 926     /* Sandy Bridge */
 927     case 0x2A: /* SNB */
 928     case 0x2D: /* SNB Xeon */
 929       do_smi = 1;
 930       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 931       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
 932       break;
 933     /* Ivy Bridge */
 934     case 0x3A: /* IVB */
 935     case 0x3E: /* IVB Xeon */
 936       do_smi = 1;
 937       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 938       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
 939       break;
 940     /* Haswell Bridge */
 941     case 0x3C: /* HSW */
 942     case 0x3F: /* HSW */
 943     case 0x46: /* HSW */
 944       do_smi = 1;
 945       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 946       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
 947       break;
 948     case 0x45: /* HSW */
 949       do_smi = 1;
 950       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 951       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) |
 952                       (1 << 9) | (1 << 10);
 953       break;
 954     /* Broadwel */
 955     case 0x4F: /* BDW */
 956     case 0x56: /* BDX-DE */
 957       do_smi = 1;
 958       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 959       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7);
 960       break;
 961     case 0x3D: /* BDW */
 962       do_smi = 1;
 963       do_core_cstate = (1 << 3) | (1 << 6) | (1 << 7);
 964       do_pkg_cstate = (1 << 2) | (1 << 3) | (1 << 6) | (1 << 7) | (1 << 8) |
 965                       (1 << 9) | (1 << 10);
 966       break;
 967     default:
 968       do_smi = 0;
 969       do_core_cstate = 0;
 970       do_pkg_cstate = 0;
 971       break;
 972     }
 973     switch (model) {
 974     case 0x2A: /* SNB */
 975     case 0x3A: /* IVB */
 976     case 0x3C: /* HSW */
 977     case 0x45: /* HSW */
 978     case 0x46: /* HSW */
 979     case 0x3D: /* BDW */
 980       do_rapl = RAPL_PKG | RAPL_CORES | RAPL_GFX;
 981       break;
 982     case 0x3F: /* HSX */
 983     case 0x4F: /* BDX */
 984     case 0x56: /* BDX-DE */
 985       do_rapl = RAPL_PKG | RAPL_DRAM;
 986       break;
 987     case 0x2D: /* SNB Xeon */
 988     case 0x3E: /* IVB Xeon */
 989       do_rapl = RAPL_PKG | RAPL_CORES | RAPL_DRAM;
 990       break;
 991     case 0x37: /* BYT */
 992     case 0x4D: /* AVN */
 993       do_rapl = RAPL_PKG | RAPL_CORES;
 994       break;
 995     default:
 996       do_rapl = 0;
 997     }
 998   } else {
 999     ERROR("turbostat plugin: Unsupported CPU (family: %#x, "
1000           "model: %#x)",
1001           family, model);
1002     return -1;
1003   }
1004
1005   /* Override detected values with configuration */
1006   if (apply_config_core_cstate)
1007     do_core_cstate = config_core_cstate;
1008   if (apply_config_pkg_cstate)
1009     do_pkg_cstate = config_pkg_cstate;
1010   if (apply_config_smi)
1011     do_smi = config_smi;
1012   if (apply_config_dts)
1013     do_dts = config_dts;
1014   if (apply_config_ptm)
1015     do_ptm = config_ptm;
1016   if (apply_config_rapl)
1017     do_rapl = config_rapl;
1018
1019   if (do_rapl) {
1020     unsigned long long msr;
1021     if (get_msr(0, MSR_RAPL_POWER_UNIT, &msr))
1022       return 0;
1023
1024     if (model == 0x37)
1025       rapl_energy_units = 1.0 * (1 << (msr >> 8 & 0x1F)) / 1000000;
1026     else
1027       rapl_energy_units = 1.0 / (1 << (msr >> 8 & 0x1F));
1028   }
1029
1030   return 0;
1031 }
1032
1033 /********************
1034  * Topology Probing *
1035  ********************/
1036
1037 /*
1038  * Read a single int from a file.
1039  */
1040 static int __attribute__((format(printf, 1, 2)))
1041 parse_int_file(const char *fmt, ...) {
1042   va_list args;
1043   char path[PATH_MAX];
1044   int len;
1045
1046   va_start(args, fmt);
1047   len = vsnprintf(path, sizeof(path), fmt, args);
1048   va_end(args);
1049   if (len < 0 || len >= PATH_MAX) {
1050     ERROR("turbostat plugin: path truncated: '%s'", path);
1051     return -1;
1052   }
1053
1054   value_t v;
1055   if (parse_value_file(path, &v, DS_TYPE_DERIVE) != 0) {
1056     ERROR("turbostat plugin: Parsing \"%s\" failed.", path);
1057     return -1;
1058   }
1059
1060   return (int)v.derive;
1061 }
1062
1063 static int get_threads_on_core(unsigned int cpu) {
1064   char path[80];
1065   FILE *filep;
1066   int sib1, sib2;
1067   int matches;
1068   char character;
1069
1070   snprintf(path, sizeof(path),
1071            "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", cpu);
1072   filep = fopen(path, "r");
1073   if (!filep) {
1074     ERROR("turbostat plugin: Failed to open '%s'", path);
1075     return -1;
1076   }
1077   /*
1078    * file format:
1079    * if a pair of number with a character between: 2 siblings (eg. 1-2, or 1,4)
1080    * otherwinse 1 sibling (self).
1081    */
1082   matches = fscanf(filep, "%d%c%d\n", &sib1, &character, &sib2);
1083
1084   fclose(filep);
1085
1086   if (matches == 3)
1087     return 2;
1088   else
1089     return 1;
1090 }
1091
1092 /*
1093  * run func(cpu) on every cpu in /proc/stat
1094  * return max_cpu number
1095  */
1096 static int __attribute__((warn_unused_result))
1097 for_all_proc_cpus(int(func)(unsigned int)) {
1098   FILE *fp;
1099   unsigned int cpu_num;
1100   int retval;
1101
1102   fp = fopen("/proc/stat", "r");
1103   if (!fp) {
1104     ERROR("turbostat plugin: Failed to open /proc/stat");
1105     return -1;
1106   }
1107
1108   retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
1109   if (retval != 0) {
1110     ERROR("turbostat plugin: Failed to parse /proc/stat");
1111     fclose(fp);
1112     return -1;
1113   }
1114
1115   while (1) {
1116     retval =
1117         fscanf(fp, "cpu%u %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n", &cpu_num);
1118     if (retval != 1)
1119       break;
1120
1121     retval = func(cpu_num);
1122     if (retval) {
1123       fclose(fp);
1124       return retval;
1125     }
1126   }
1127   fclose(fp);
1128   return 0;
1129 }
1130
1131 /*
1132  * Update the stored topology.max_cpu_id
1133  */
1134 static int update_max_cpu_id(unsigned int cpu) {
1135   if (topology.max_cpu_id < cpu)
1136     topology.max_cpu_id = cpu;
1137   return 0;
1138 }
1139
1140 static int mark_cpu_present(unsigned int cpu) {
1141   CPU_SET_S(cpu, cpu_present_setsize, cpu_present_set);
1142   return 0;
1143 }
1144
1145 static int __attribute__((warn_unused_result))
1146 allocate_cpu_set(cpu_set_t **set, size_t *size) {
1147   *set = CPU_ALLOC(topology.max_cpu_id + 1);
1148   if (*set == NULL) {
1149     ERROR("turbostat plugin: Unable to allocate CPU state");
1150     return -1;
1151   }
1152   *size = CPU_ALLOC_SIZE(topology.max_cpu_id + 1);
1153   CPU_ZERO_S(*size, *set);
1154   return 0;
1155 }
1156
1157 /*
1158  * Build a local representation of the cpu distribution
1159  */
1160 static int __attribute__((warn_unused_result)) topology_probe(void) {
1161   int ret;
1162   unsigned int max_package_id, max_core_id, max_threads;
1163   max_package_id = max_core_id = max_threads = 0;
1164
1165   /* Clean topology */
1166   free(topology.cpus);
1167   memset(&topology, 0, sizeof(topology));
1168
1169   ret = for_all_proc_cpus(update_max_cpu_id);
1170   if (ret != 0)
1171     goto err;
1172
1173   topology.cpus =
1174       calloc(1, (topology.max_cpu_id + 1) * sizeof(struct cpu_topology));
1175   if (topology.cpus == NULL) {
1176     ERROR("turbostat plugin: Unable to allocate memory for CPU topology");
1177     return -1;
1178   }
1179
1180   ret = allocate_cpu_set(&cpu_present_set, &cpu_present_setsize);
1181   if (ret != 0)
1182     goto err;
1183   ret = allocate_cpu_set(&cpu_affinity_set, &cpu_affinity_setsize);
1184   if (ret != 0)
1185     goto err;
1186   ret = allocate_cpu_set(&cpu_saved_affinity_set, &cpu_saved_affinity_setsize);
1187   if (ret != 0)
1188     goto err;
1189
1190   ret = for_all_proc_cpus(mark_cpu_present);
1191   if (ret != 0)
1192     goto err;
1193
1194   /*
1195    * For online cpus
1196    * find max_core_id, max_package_id
1197    */
1198   for (unsigned int i = 0; i <= topology.max_cpu_id; ++i) {
1199     unsigned int num_threads;
1200     struct cpu_topology *cpu = &topology.cpus[i];
1201
1202     if (cpu_is_not_present(i)) {
1203       WARNING("turbostat plugin: cpu%d NOT PRESENT", i);
1204       continue;
1205     }
1206
1207     ret = parse_int_file(
1208         "/sys/devices/system/cpu/cpu%d/topology/physical_package_id", i);
1209     if (ret < 0)
1210       goto err;
1211     else
1212       cpu->package_id = (unsigned int)ret;
1213     if (cpu->package_id > max_package_id)
1214       max_package_id = cpu->package_id;
1215
1216     ret = parse_int_file("/sys/devices/system/cpu/cpu%d/topology/core_id", i);
1217     if (ret < 0)
1218       goto err;
1219     else
1220       cpu->core_id = (unsigned int)ret;
1221     if (cpu->core_id > max_core_id)
1222       max_core_id = cpu->core_id;
1223     ret = parse_int_file(
1224         "/sys/devices/system/cpu/cpu%d/topology/core_siblings_list", i);
1225     if (ret < 0)
1226       goto err;
1227     else if ((unsigned int)ret == i)
1228       cpu->first_core_in_package = 1;
1229
1230     ret = get_threads_on_core(i);
1231     if (ret < 0)
1232       goto err;
1233     else
1234       num_threads = (unsigned int)ret;
1235     if (num_threads > max_threads)
1236       max_threads = num_threads;
1237     ret = parse_int_file(
1238         "/sys/devices/system/cpu/cpu%d/topology/thread_siblings_list", i);
1239     if (ret < 0)
1240       goto err;
1241     else if ((unsigned int)ret == i)
1242       cpu->first_thread_in_core = 1;
1243
1244     DEBUG("turbostat plugin: cpu %d pkg %d core %d\n", i, cpu->package_id,
1245           cpu->core_id);
1246   }
1247   /* Num is max + 1 (need to count 0) */
1248   topology.num_packages = max_package_id + 1;
1249   topology.num_cores = max_core_id + 1;
1250   topology.num_threads = max_threads;
1251
1252   return 0;
1253 err:
1254   free(topology.cpus);
1255   return ret;
1256 }
1257
1258 /************************
1259  * Main alloc/init/free *
1260  ************************/
1261
1262 static int allocate_counters(struct thread_data **threads,
1263                              struct core_data **cores,
1264                              struct pkg_data **packages) {
1265   unsigned int total_threads, total_cores;
1266
1267   if ((topology.num_threads == 0) || (topology.num_cores == 0) ||
1268       (topology.num_packages == 0)) {
1269     ERROR(
1270         "turbostat plugin: Invalid topology: %u threads, %u cores, %u packages",
1271         topology.num_threads, topology.num_cores, topology.num_packages);
1272     return -1;
1273   }
1274
1275   total_threads =
1276       topology.num_threads * topology.num_cores * topology.num_packages;
1277   *threads = calloc(total_threads, sizeof(struct thread_data));
1278   if (*threads == NULL) {
1279     ERROR("turbostat plugin: calloc failed");
1280     return -1;
1281   }
1282
1283   for (unsigned int i = 0; i < total_threads; ++i)
1284     (*threads)[i].cpu_id = topology.max_cpu_id + 1;
1285
1286   total_cores = topology.num_cores * topology.num_packages;
1287   *cores = calloc(total_cores, sizeof(struct core_data));
1288   if (*cores == NULL) {
1289     ERROR("turbostat plugin: calloc failed");
1290     sfree(threads);
1291     return -1;
1292   }
1293
1294   *packages = calloc(topology.num_packages, sizeof(struct pkg_data));
1295   if (*packages == NULL) {
1296     ERROR("turbostat plugin: calloc failed");
1297     sfree(cores);
1298     sfree(threads);
1299     return -1;
1300   }
1301
1302   return 0;
1303 }
1304
1305 static void init_counter(struct thread_data *thread_base,
1306                          struct core_data *core_base, struct pkg_data *pkg_base,
1307                          unsigned int cpu_id) {
1308   struct thread_data *t;
1309   struct core_data *c;
1310   struct pkg_data *p;
1311   struct cpu_topology *cpu = &topology.cpus[cpu_id];
1312
1313   t = GET_THREAD(thread_base, !(cpu->first_thread_in_core), cpu->core_id,
1314                  cpu->package_id);
1315   c = GET_CORE(core_base, cpu->core_id, cpu->package_id);
1316   p = GET_PKG(pkg_base, cpu->package_id);
1317
1318   t->cpu_id = cpu_id;
1319   if (cpu->first_thread_in_core)
1320     t->flags |= CPU_IS_FIRST_THREAD_IN_CORE;
1321   if (cpu->first_core_in_package)
1322     t->flags |= CPU_IS_FIRST_CORE_IN_PACKAGE;
1323
1324   c->core_id = cpu->core_id;
1325   p->package_id = cpu->package_id;
1326 }
1327
1328 static void initialize_counters(void) {
1329   for (unsigned int cpu_id = 0; cpu_id <= topology.max_cpu_id; ++cpu_id) {
1330     if (cpu_is_not_present(cpu_id))
1331       continue;
1332     init_counter(EVEN_COUNTERS, cpu_id);
1333     init_counter(ODD_COUNTERS, cpu_id);
1334     init_counter(DELTA_COUNTERS, cpu_id);
1335   }
1336 }
1337
1338 static void free_all_buffers(void) {
1339   allocated = 0;
1340   initialized = 0;
1341
1342   CPU_FREE(cpu_present_set);
1343   cpu_present_set = NULL;
1344   cpu_present_setsize = 0;
1345
1346   CPU_FREE(cpu_affinity_set);
1347   cpu_affinity_set = NULL;
1348   cpu_affinity_setsize = 0;
1349
1350   CPU_FREE(cpu_saved_affinity_set);
1351   cpu_saved_affinity_set = NULL;
1352   cpu_saved_affinity_setsize = 0;
1353
1354   free(thread_even);
1355   free(core_even);
1356   free(package_even);
1357
1358   thread_even = NULL;
1359   core_even = NULL;
1360   package_even = NULL;
1361
1362   free(thread_odd);
1363   free(core_odd);
1364   free(package_odd);
1365
1366   thread_odd = NULL;
1367   core_odd = NULL;
1368   package_odd = NULL;
1369
1370   free(thread_delta);
1371   free(core_delta);
1372   free(package_delta);
1373
1374   thread_delta = NULL;
1375   core_delta = NULL;
1376   package_delta = NULL;
1377 }
1378
1379 /**********************
1380  * Collectd functions *
1381  **********************/
1382
1383 #define DO_OR_GOTO_ERR(something)                                              \
1384   do {                                                                         \
1385     ret = (something);                                                         \
1386     if (ret < 0)                                                               \
1387       goto err;                                                                \
1388   } while (0)
1389
1390 static int setup_all_buffers(void) {
1391   int ret;
1392
1393   DO_OR_GOTO_ERR(topology_probe());
1394   DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
1395   DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
1396   DO_OR_GOTO_ERR(allocate_counters(&thread_delta, &core_delta, &package_delta));
1397   initialize_counters();
1398   DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
1399   DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, ODD_COUNTERS));
1400
1401   allocated = 1;
1402   return 0;
1403 err:
1404   free_all_buffers();
1405   return ret;
1406 }
1407
1408 static int turbostat_read(void) {
1409   int ret;
1410
1411   if (!allocated) {
1412     if ((ret = setup_all_buffers()) < 0)
1413       return ret;
1414   }
1415
1416   if (for_all_proc_cpus(cpu_is_not_present)) {
1417     free_all_buffers();
1418     if ((ret = setup_all_buffers()) < 0)
1419       return ret;
1420     if (for_all_proc_cpus(cpu_is_not_present)) {
1421       ERROR("turbostat plugin: CPU appeared just after "
1422             "initialization");
1423       return -1;
1424     }
1425   }
1426
1427   /* Saving the scheduling affinity, as it will be modified by get_counters */
1428   if (sched_getaffinity(0, cpu_saved_affinity_setsize,
1429                         cpu_saved_affinity_set) != 0) {
1430     ERROR("turbostat plugin: Unable to save the CPU affinity");
1431     return -1;
1432   }
1433
1434   if (!initialized) {
1435     if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1436       goto out;
1437     time_even = cdtime();
1438     is_even = 1;
1439     initialized = 1;
1440     ret = 0;
1441     goto out;
1442   }
1443
1444   if (is_even) {
1445     if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
1446       goto out;
1447     time_odd = cdtime();
1448     is_even = 0;
1449     time_delta = time_odd - time_even;
1450     if ((ret = for_all_cpus_delta(ODD_COUNTERS, EVEN_COUNTERS)) < 0)
1451       goto out;
1452     if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1453       goto out;
1454   } else {
1455     if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
1456       goto out;
1457     time_even = cdtime();
1458     is_even = 1;
1459     time_delta = time_even - time_odd;
1460     if ((ret = for_all_cpus_delta(EVEN_COUNTERS, ODD_COUNTERS)) < 0)
1461       goto out;
1462     if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
1463       goto out;
1464   }
1465   ret = 0;
1466 out:
1467   /*
1468    * Let's restore the affinity
1469    * This might fail if the number of CPU changed, but we can't do anything in
1470    * that case..
1471    */
1472   (void)sched_setaffinity(0, cpu_saved_affinity_setsize,
1473                           cpu_saved_affinity_set);
1474   return ret;
1475 }
1476
1477 static int check_permissions(void) {
1478
1479   if (getuid() == 0) {
1480     /* We have everything we need */
1481     return 0;
1482 #if !defined(HAVE_SYS_CAPABILITY_H) && !defined(CAP_SYS_RAWIO)
1483   } else {
1484     ERROR("turbostat plugin: Initialization failed: this plugin "
1485           "requires collectd to run as root");
1486     return -1;
1487   }
1488 #else  /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1489   }
1490
1491   int ret = 0;
1492
1493   if (check_capability(CAP_SYS_RAWIO) != 0) {
1494     WARNING("turbostat plugin: Collectd doesn't have the "
1495             "CAP_SYS_RAWIO capability. If you don't want to run "
1496             "collectd as root, try running \"setcap "
1497             "cap_sys_rawio=ep\" on collectd binary");
1498     ret = -1;
1499   }
1500
1501   if (euidaccess("/dev/cpu/0/msr", R_OK)) {
1502     WARNING("turbostat plugin: Collectd cannot open "
1503             "/dev/cpu/0/msr. If you don't want to run collectd as "
1504             "root, you need to change the ownership (chown) and "
1505             "permissions on /dev/cpu/*/msr to allow such access");
1506     ret = -1;
1507   }
1508
1509   if (ret != 0)
1510     ERROR("turbostat plugin: Initialization failed: this plugin "
1511           "requires collectd to either to run as root or give "
1512           "collectd a special capability (CAP_SYS_RAWIO) and read "
1513           "access to /dev/cpu/*/msr (see previous warnings)");
1514   return ret;
1515 #endif /* HAVE_SYS_CAPABILITY_H && CAP_SYS_RAWIO */
1516 }
1517
1518 static int turbostat_init(void) {
1519   struct stat sb;
1520   int ret;
1521
1522   if (stat("/dev/cpu/0/msr", &sb)) {
1523     ERROR("turbostat plugin: Initialization failed: /dev/cpu/0/msr "
1524           "does not exist while the CPU supports MSR. You may be "
1525           "missing the corresponding kernel module, please try '# "
1526           "modprobe msr'");
1527     return -1;
1528   }
1529
1530   DO_OR_GOTO_ERR(check_permissions());
1531
1532   DO_OR_GOTO_ERR(probe_cpu());
1533
1534   DO_OR_GOTO_ERR(setup_all_buffers());
1535
1536   plugin_register_read(PLUGIN_NAME, turbostat_read);
1537
1538   return 0;
1539 err:
1540   free_all_buffers();
1541   return ret;
1542 }
1543
1544 static int turbostat_config(const char *key, const char *value) {
1545   long unsigned int tmp_val;
1546   char *end;
1547
1548   if (strcasecmp("CoreCstates", key) == 0) {
1549     tmp_val = strtoul(value, &end, 0);
1550     if (*end != '\0' || tmp_val > UINT_MAX) {
1551       ERROR("turbostat plugin: Invalid CoreCstates '%s'", value);
1552       return -1;
1553     }
1554     config_core_cstate = (unsigned int)tmp_val;
1555     apply_config_core_cstate = 1;
1556   } else if (strcasecmp("PackageCstates", key) == 0) {
1557     tmp_val = strtoul(value, &end, 0);
1558     if (*end != '\0' || tmp_val > UINT_MAX) {
1559       ERROR("turbostat plugin: Invalid PackageCstates '%s'", value);
1560       return -1;
1561     }
1562     config_pkg_cstate = (unsigned int)tmp_val;
1563     apply_config_pkg_cstate = 1;
1564   } else if (strcasecmp("SystemManagementInterrupt", key) == 0) {
1565     config_smi = IS_TRUE(value);
1566     apply_config_smi = 1;
1567   } else if (strcasecmp("DigitalTemperatureSensor", key) == 0) {
1568     config_dts = IS_TRUE(value);
1569     apply_config_dts = 1;
1570   } else if (strcasecmp("PackageThermalManagement", key) == 0) {
1571     config_ptm = IS_TRUE(value);
1572     apply_config_ptm = 1;
1573   } else if (strcasecmp("LogicalCoreNames", key) == 0) {
1574     config_lcn = IS_TRUE(value);
1575   } else if (strcasecmp("RunningAveragePowerLimit", key) == 0) {
1576     tmp_val = strtoul(value, &end, 0);
1577     if (*end != '\0' || tmp_val > UINT_MAX) {
1578       ERROR("turbostat plugin: Invalid RunningAveragePowerLimit '%s'", value);
1579       return -1;
1580     }
1581     config_rapl = (unsigned int)tmp_val;
1582     apply_config_rapl = 1;
1583   } else if (strcasecmp("TCCActivationTemp", key) == 0) {
1584     tmp_val = strtoul(value, &end, 0);
1585     if (*end != '\0' || tmp_val > UINT_MAX) {
1586       ERROR("turbostat plugin: Invalid TCCActivationTemp '%s'", value);
1587       return -1;
1588     }
1589     tcc_activation_temp = (unsigned int)tmp_val;
1590   } else {
1591     ERROR("turbostat plugin: Invalid configuration option '%s'", key);
1592     return -1;
1593   }
1594   return 0;
1595 }
1596
1597 void module_register(void) {
1598   plugin_register_init(PLUGIN_NAME, turbostat_init);
1599   plugin_register_config(PLUGIN_NAME, turbostat_config, config_keys,
1600                          config_keys_num);
1601 }