*/
#define _GNU_SOURCE
+#include "collectd.h"
+#include "common.h"
+#include "plugin.h"
+#include "utils_time.h"
+
#include <asm/msr-index.h>
#include <stdarg.h>
#include <stdio.h>
#include <sys/resource.h>
#include <fcntl.h>
#include <signal.h>
-#include <sys/time.h>
#include <stdlib.h>
#include <dirent.h>
#include <string.h>
#include <ctype.h>
#include <sched.h>
#include <cpuid.h>
-
-#include "collectd.h"
-#include "common.h"
-#include "plugin.h"
+#include <sys/capability.h>
#define PLUGIN_NAME "turbostat"
/* 0x642 MSR_PP1_POLICY */
#define TJMAX_DEFAULT 100
-cpu_set_t *cpu_present_set, *cpu_affinity_set, *cpu_saved_affinity_set;
-size_t cpu_present_setsize, cpu_affinity_setsize, cpu_saved_affinity_setsize;
+static cpu_set_t *cpu_present_set, *cpu_affinity_set, *cpu_saved_affinity_set;
+static size_t cpu_present_setsize, cpu_affinity_setsize, cpu_saved_affinity_setsize;
-struct thread_data {
+static struct thread_data {
unsigned long long tsc;
unsigned long long aperf;
unsigned long long mperf;
#define CPU_IS_FIRST_CORE_IN_PACKAGE 0x4
} *thread_delta, *thread_even, *thread_odd;
-struct core_data {
+static struct core_data {
unsigned long long c3;
unsigned long long c6;
unsigned long long c7;
unsigned int core_id;
} *core_delta, *core_even, *core_odd;
-struct pkg_data {
+static struct pkg_data {
unsigned long long pc2;
unsigned long long pc3;
unsigned long long pc6;
_Bool first_thread_in_core;
};
-struct topology {
+static struct topology {
int max_cpu_id;
int num_packages;
int num_cores;
struct cpu_topology *cpus;
} topology;
-struct timeval tv_even, tv_odd, tv_delta;
-
-enum return_values {
- OK = 0,
- ERR_CPU_MIGRATE,
- ERR_CPU_SAVE_SCHED_AFFINITY,
- ERR_MSR_IA32_APERF,
- ERR_MSR_IA32_MPERF,
- ERR_MSR_SMI_COUNT,
- ERR_MSR_CORE_C3_RESIDENCY,
- ERR_MSR_CORE_C6_RESIDENCY,
- ERR_MSR_CORE_C7_RESIDENCY,
- ERR_MSR_IA32_THERM_STATUS,
- ERR_MSR_PKG_C3_RESIDENCY,
- ERR_MSR_PKG_C6_RESIDENCY,
- ERR_MSR_PKG_C2_RESIDENCY,
- ERR_MSR_PKG_C7_RESIDENCY,
- ERR_MSR_PKG_C8_RESIDENCY,
- ERR_MSR_PKG_C9_RESIDENCY,
- ERR_MSR_PKG_C10_RESIDENCY,
- ERR_MSR_PKG_ENERGY_STATUS,
- ERR_MSR_PKG_POWER_INFO,
- ERR_MSR_PP0_ENERGY_STATUS,
- ERR_MSR_DRAM_ENERGY_STATUS,
- ERR_MSR_PP1_ENERGY_STATUS,
- ERR_MSR_PKG_PERF_STATUS,
- ERR_MSR_DRAM_PERF_STATUS,
- ERR_MSR_IA32_PACKAGE_THERM_STATUS,
- ERR_MSR_IA32_TSC,
- ERR_CPU_NOT_PRESENT,
- ERR_NO_MSR,
- ERR_CANT_OPEN_MSR,
- ERR_CANT_OPEN_FILE,
- ERR_CANT_READ_NUMBER,
- ERR_CANT_READ_PROC_STAT,
- ERR_NO_INVARIANT_TSC,
- ERR_NO_APERF,
- ERR_CALLOC,
- ERR_CPU_ALLOC,
- ERR_NOT_ROOT,
- UNSUPPORTED_CPU,
- ERR_PATH_TOO_LONG,
-};
+static cdtime_t time_even, time_odd, time_delta;
+static const char *config_keys[] =
+{
+ "TCCActivationTemp",
+};
+static const int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
/*****************************
* MSR Manipulation helpers *
CPU_SET_S(cpu, cpu_affinity_setsize, cpu_affinity_set);
if (sched_setaffinity(0, cpu_affinity_setsize, cpu_affinity_set) == -1) {
ERROR("Turbostat plugin: Could not migrate to CPU %d", cpu);
- return -ERR_CPU_MIGRATE;
+ return -1;
}
}
ssnprintf(pathname, sizeof(pathname), "/dev/cpu/%d/msr", cpu);
fd = open(pathname, O_RDONLY);
- if (fd < 0)
- return -ERR_CANT_OPEN_MSR;
+ if (fd < 0) {
+ ERROR("Turbostat plugin: failed to open %s", pathname);
+ return -1;
+ }
return fd;
}
if (msr_fd < 0)
return msr_fd;
-#define READ_MSR(msr, dst) \
-do { \
- if (read_msr(msr_fd, msr, dst)) { \
- retval = -ERR_##msr; \
- goto out; \
- } \
+#define READ_MSR(msr, dst) \
+do { \
+ if (read_msr(msr_fd, msr, dst)) { \
+ ERROR("Turbostat plugin: Unable to read " #msr); \
+ retval = -1; \
+ goto out; \
+ } \
} while (0)
READ_MSR(MSR_IA32_TSC, &t->tsc);
char name[DATA_MAX_NAME_LEN];
double interval_float;
- interval_float = tv_delta.tv_sec + tv_delta.tv_usec/1000000.0;
+ interval_float = CDTIME_T_TO_DOUBLE(time_delta);
ssnprintf(name, sizeof(name), "cpu%02d", t->cpu_id);
if (!aperf_mperf_unstable)
turbostat_submit(name, "percent", "c1", 100.0 * t->c1/t->tsc);
- /* GHz */
+ turbostat_submit("Average", "frequency", name, 1.0 / 1000000 * t->aperf / interval_float);
+
if ((!aperf_mperf_unstable) || (!(t->aperf > t->tsc || t->mperf > t->tsc)))
- turbostat_submit(NULL, "frequency", name, 1.0 * t->tsc / 1000000000 * t->aperf / t->mperf / interval_float);
+ turbostat_submit("Buzy", "frequency", name, 1.0 * t->tsc / 1000000 * t->aperf / t->mperf / interval_float);
+
+ /* Sanity check (should stay stable) */
+ turbostat_submit("TSC", "gauge", name, 1.0 * t->tsc / 1000000 / interval_float);
/* SMI */
turbostat_submit(NULL, "current", name, t->smi_count);
__get_cpuid(0, &max_level, &ebx, &ecx, &edx);
if (ebx != 0x756e6547 && edx != 0x49656e69 && ecx != 0x6c65746e) {
ERROR("Turbostat plugin: Unsupported CPU (not Intel)");
- return -UNSUPPORTED_CPU;
+ return -1;
}
/* CPUID(1):
model += ((fms >> 16) & 0xf) << 4;
if (!(edx & (1 << 5))) {
ERROR("Turbostat plugin: Unsupported CPU (no MSR support)");
- return -ERR_NO_MSR;
+ return -1;
}
/*
if (max_level < 0x80000007) {
ERROR("Turbostat plugin: Unsupported CPU (no invariant TSC, "
" Maximum Extended Function: 0x%x)", max_level);
- return -ERR_NO_INVARIANT_TSC;
+ return -1;
}
/*
__get_cpuid(0x80000007, &eax, &ebx, &ecx, &edx);
if (!(edx & (1 << 8))) {
ERROR("Turbostat plugin: Unsupported CPU (No invariant TSC)");
- return -ERR_NO_INVARIANT_TSC;
+ return -1;
}
/*
do_ptm = eax & (1 << 6);
if (!(ecx & (1 << 0))) {
ERROR("Turbostat plugin: Unsupported CPU (No APERF)");
- return -ERR_NO_APERF;
+ return -1;
}
/*
break;
/* Silvermont */
case 0x37: /* BYT */
- case 0x4A:
case 0x4D: /* AVN */
- case 0x5A:
- case 0x5D:
do_core_cstate = (1 << 1) | (1 << 6);
do_pkg_cstate = (1 << 6);
break;
} else {
ERROR("Turbostat plugin: Unsupported CPU (family: %#x, "
"model: %#x)", family, model);
- return -UNSUPPORTED_CPU;
+ return -1;
}
if (do_rapl) {
va_end(args);
if (len < 0 || len >= PATH_MAX) {
ERROR("Turbostat plugin: path truncated: '%s'", path);
- return -ERR_PATH_TOO_LONG;
+ return -1;
}
filep = fopen(path, "r");
if (!filep) {
ERROR("Turbostat plugin: Failed to open '%s'", path);
- return -ERR_CANT_OPEN_FILE;
+ return -1;
}
if (fscanf(filep, "%d", &value) != 1) {
ERROR("Turbostat plugin: Failed to parse number from '%s'", path);
- return -ERR_CANT_READ_NUMBER;
+ return -1;
}
fclose(filep);
return value;
filep = fopen(path, "r");
if (!filep) {
ERROR("Turbostat plugin: Failed to open '%s'", path);
- return -ERR_CANT_OPEN_FILE;
+ return -1;
}
/*
* file format:
fp = fopen("/proc/stat", "r");
if (!fp) {
ERROR("Turbostat plugin: Failed to open /proc/stat");
- return -ERR_CANT_OPEN_FILE;
+ return -1;
}
retval = fscanf(fp, "cpu %*d %*d %*d %*d %*d %*d %*d %*d %*d %*d\n");
if (retval != 0) {
ERROR("Turbostat plugin: Failed to parse /proc/stat");
fclose(fp);
- return -ERR_CANT_READ_PROC_STAT;
+ return -1;
}
while (1) {
*set = CPU_ALLOC(topology.max_cpu_id + 1);
if (*set == NULL) {
ERROR("Turbostat plugin: Unable to allocate CPU state");
- return -ERR_CPU_ALLOC;
+ return -1;
}
*size = CPU_ALLOC_SIZE(topology.max_cpu_id + 1);
CPU_ZERO_S(*size, *set);
topology.cpus = calloc(1, (topology.max_cpu_id + 1) * sizeof(struct cpu_topology));
if (topology.cpus == NULL) {
ERROR("Turbostat plugin: Unable to allocate memory for CPU topology");
- return -ERR_CALLOC;
+ return -1;
}
ret = allocate_cpu_set(&cpu_present_set, &cpu_present_setsize);
free(*threads);
err:
ERROR("Turbostat plugin: Failled to allocate memory for counters");
- return -ERR_CALLOC;
+ return -1;
}
-static int
+static void
init_counter(struct thread_data *thread_base, struct core_data *core_base,
struct pkg_data *pkg_base, int cpu_id)
{
c->core_id = cpu->core_id;
p->package_id = cpu->package_id;
-
- return 0;
}
-static int
+static void
initialize_counters(void)
{
- int ret;
int cpu_id;
for (cpu_id = 0; cpu_id <= topology.max_cpu_id; ++cpu_id) {
- if (cpu_is_not_present(cpu_id)) {
+ if (cpu_is_not_present(cpu_id))
continue;
- }
-
- ret = init_counter(EVEN_COUNTERS, cpu_id);
- if (ret < 0)
- return ret;
- ret = init_counter(ODD_COUNTERS, cpu_id);
- if (ret < 0)
- return ret;
- ret = init_counter(DELTA_COUNTERS, cpu_id);
- if (ret < 0)
- return ret;
+ init_counter(EVEN_COUNTERS, cpu_id);
+ init_counter(ODD_COUNTERS, cpu_id);
+ init_counter(DELTA_COUNTERS, cpu_id);
}
- return 0;
}
DO_OR_GOTO_ERR(allocate_counters(&thread_even, &core_even, &package_even));
DO_OR_GOTO_ERR(allocate_counters(&thread_odd, &core_odd, &package_odd));
DO_OR_GOTO_ERR(allocate_counters(&thread_delta, &core_delta, &package_delta));
- DO_OR_GOTO_ERR(initialize_counters());
+ initialize_counters();
DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, EVEN_COUNTERS));
DO_OR_GOTO_ERR(for_all_cpus(set_temperature_target, ODD_COUNTERS));
free_all_buffers();
if ((ret = setup_all_buffers()) < 0)
return ret;
- if (for_all_proc_cpus(cpu_is_not_present))
- return -ERR_CPU_NOT_PRESENT;
+ if (for_all_proc_cpus(cpu_is_not_present)) {
+ ERROR("Turbostat plugin: CPU appeared just after "
+ "initialization");
+ return -1;
+ }
}
/* Saving the scheduling affinity, as it will be modified by get_counters */
- if (sched_getaffinity(0, cpu_saved_affinity_setsize, cpu_saved_affinity_set) != 0)
- return -ERR_CPU_SAVE_SCHED_AFFINITY;
+ if (sched_getaffinity(0, cpu_saved_affinity_setsize, cpu_saved_affinity_set) != 0) {
+ ERROR("Turbostat plugin: Unable to save the CPU affinity");
+ return -1;
+ }
if (!initialized) {
if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
goto out;
- gettimeofday(&tv_even, (struct timezone *)NULL);
+ time_even = cdtime();
is_even = 1;
initialized = 1;
ret = 0;
if (is_even) {
if ((ret = for_all_cpus(get_counters, ODD_COUNTERS)) < 0)
goto out;
- gettimeofday(&tv_odd, (struct timezone *)NULL);
+ time_odd = cdtime();
is_even = 0;
- timersub(&tv_odd, &tv_even, &tv_delta);
+ time_delta = time_odd - time_even;
if ((ret = for_all_cpus_delta(ODD_COUNTERS, EVEN_COUNTERS)) < 0)
goto out;
if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
} else {
if ((ret = for_all_cpus(get_counters, EVEN_COUNTERS)) < 0)
goto out;
- gettimeofday(&tv_even, (struct timezone *)NULL);
+ time_even = cdtime();
is_even = 1;
- timersub(&tv_even, &tv_odd, &tv_delta);
+ time_delta = time_even - time_odd;
if ((ret = for_all_cpus_delta(EVEN_COUNTERS, ODD_COUNTERS)) < 0)
goto out;
if ((ret = for_all_cpus(submit_counters, DELTA_COUNTERS)) < 0)
}
static int
-turbostat_init(void)
+check_permissions(void)
{
- struct stat sb;
- int ret;
+ struct __user_cap_header_struct cap_header_data;
+ cap_user_header_t cap_header = &cap_header_data;
+ struct __user_cap_data_struct cap_data_data;
+ cap_user_data_t cap_data = &cap_data_data;
+ int ret = 0;
+
+ if (getuid() == 0) {
+ /* We have everything we need */
+ return 0;
+ }
- if (getuid() != 0) {
- ERROR("Turbostat plugin: Initialization failed: this plugin "
- "requires collectd to run as root in order to read "
- "special CPU registers");
- return -ERR_NOT_ROOT;
+ /* check for CAP_SYS_RAWIO */
+ cap_header->pid = getpid();
+ cap_header->version = _LINUX_CAPABILITY_VERSION;
+ if (capget(cap_header, cap_data) < 0) {
+ ERROR("Turbostat plugin: capget failed");
+ return -1;
}
- DO_OR_GOTO_ERR(probe_cpu());
+ if ((cap_data->effective & (1 << CAP_SYS_RAWIO)) == 0) {
+ WARNING("Turbostat plugin: Collectd doesn't have the "
+ "CAP_SYS_RAWIO capability. If you don't want to run "
+ "collectd as root, try running \"setcap "
+ "cap_sys_rawio=ep\" on collectd binary");
+ ret = -1;
+ }
+
+ if (euidaccess("/dev/cpu/0/msr", R_OK)) {
+ WARNING("Turbostat plugin: Collectd cannot open"
+ "/dev/cpu/0/msr. If you don't want to run collectd as "
+ "root, you need to change the ownership (chown) and "
+ "permissions on /dev/cpu/*/msr to allow such access");
+ ret = -1;
+ }
+
+ if (ret != 0)
+ ERROR("Turbostat plugin: Initialization failed: this plugin "
+ "requires collectd to either to run as root or give "
+ "collectd a special capability (CAP_SYS_RAWIO) and read "
+ "access to /dev/cpu/*/msr (see previous warnings)");
+ return ret;
+}
+
+static int
+turbostat_init(void)
+{
+ struct stat sb;
+ int ret;
if (stat("/dev/cpu/0/msr", &sb)) {
ERROR("Turbostat plugin: Initialization failed: /dev/cpu/0/msr"
" does not exist while the CPU supports MSR. You may be "
"missing the corresponding kernel module, please try '# "
"modprobe msr'");
- return -ERR_NO_MSR;
+ return -1;
}
+ DO_OR_GOTO_ERR(check_permissions());
+
+ DO_OR_GOTO_ERR(probe_cpu());
+
DO_OR_GOTO_ERR(setup_all_buffers());
plugin_register_read(PLUGIN_NAME, turbostat_read);
return ret;
}
-static const char *config_keys[] =
-{
- "TCCActivationTemp",
-};
-static const int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
-
static int
turbostat_config(const char *key, const char *value)
{
if (strcasecmp("TCCActivationTemp", key) == 0) {
tmp_val = strtoul(value, &end, 0);
- if (*end != '\0' || tmp_val > UINT_MAX)
+ if (*end != '\0' || tmp_val > UINT_MAX) {
+ ERROR("Turbostat plugin: Invalid TCCActivationTemp '%s'",
+ value);
return -1;
+ }
tcc_activation_temp = (unsigned int) tmp_val;
} else {
+ ERROR("Turbostat plugin: Invalid configuration option '%s'",
+ key);
return -1;
}
return 0;
projects / collectd.git / blobdiff