src/thermal.c

   1 /**
   2  * collectd - src/thermal.c
   3  * Copyright (C) 2008  Michał Mirosław
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Michał Mirosław <mirq-linux at rere.qmqm.pl>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26 #include "utils_ignorelist.h"
  27
  28 #if !KERNEL_LINUX
  29 # error "This module is for Linux only."
  30 #endif
  31
  32 const char *const dirname_sysfs = "/sys/class/thermal";
  33 const char *const dirname_procfs = "/proc/acpi/thermal_zone";
  34
  35 static char force_procfs = 0;
  36 static ignorelist_t *device_list;
  37 static value_list_t vl_temp_template = VALUE_LIST_STATIC;
  38 static value_list_t vl_state_template = VALUE_LIST_STATIC;
  39
  40 enum dev_type {
  41         TEMP = 0,
  42         COOLING_DEV
  43 };
  44
  45 static void thermal_submit (const char *plugin_instance, enum dev_type dt,
  46                 gauge_t value)
  47 {
  48         value_list_t vl = (dt == TEMP) ? vl_temp_template : vl_state_template;
  49         value_t vt;
  50
  51         vt.gauge = value;
  52
  53         vl.values = &vt;
  54         vl.time = time (NULL);
  55         sstrncpy (vl.plugin, "thermal", sizeof(vl.plugin));
  56         sstrncpy (vl.plugin_instance, plugin_instance,
  57                         sizeof(vl.plugin_instance));
  58         sstrncpy (vl.type, (dt == TEMP) ? "temperature" : "gauge",
  59                         sizeof (vl.type));
  60
  61         plugin_dispatch_values (&vl);
  62 }
  63
  64 static int thermal_sysfs_device_read (const char *name)
  65 {
  66         char filename[256];
  67         char data[1024];
  68         int len;
  69         int ok = 0;
  70
  71         if (device_list && ignorelist_match (device_list, name))
  72                 return -1;
  73
  74         len = snprintf (filename, sizeof (filename), "%s/%s/temp", dirname_sysfs, name);
  75         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
  76                 return -1;
  77
  78         len = read_file_contents (filename, data, sizeof(data));
  79         if (len > 1 && data[--len] == '\n') {
  80                 char *endptr = NULL;
  81                 double temp;
  82
  83                 data[len] = 0;
  84                 errno = 0;
  85                 temp = strtod (data, &endptr) / 1000.0;
  86
  87                 if (endptr == data + len && errno == 0) {
  88                         thermal_submit(name, TEMP, temp);
  89                         ++ok;
  90                 }
  91         }
  92
  93         len = snprintf (filename, sizeof (filename), "%s/%s/cur_state", dirname_sysfs, name);
  94         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
  95                 return -1;
  96
  97         len = read_file_contents (filename, data, sizeof(data));
  98         if (len > 1 && data[--len] == '\n') {
  99                 char *endptr = NULL;
 100                 double state;
 101
 102                 data[len] = 0;
 103                 errno = 0;
 104                 state = strtod (data, &endptr);
 105
 106                 if (endptr == data + len && errno == 0) {
 107                         thermal_submit(name, COOLING_DEV, state);
 108                         ++ok;
 109                 }
 110         }
 111
 112         return ok ? 0 : -1;
 113 }
 114
 115 static int thermal_procfs_device_read (const char *name)
 116 {
 117         const char str_temp[] = "temperature:";
 118         char filename[256];
 119         char data[1024];
 120         int len;
 121
 122         if (device_list && ignorelist_match (device_list, name))
 123                 return -1;
 124
 125         /**
 126          * rechot ~ # cat /proc/acpi/thermal_zone/THRM/temperature
 127          * temperature:             55 C
 128          */
 129
 130         len = snprintf (filename, sizeof (filename), "%s/%s/temperature", dirname_procfs, name);
 131         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
 132                 return -1;
 133
 134         len = read_file_contents (filename, data, sizeof(data));
 135         if (len > sizeof(str_temp) && data[--len] == '\n' && !strncmp(data, str_temp, sizeof(str_temp)-1)) {
 136                 char *endptr = NULL;
 137                 double temp;
 138                 double celsius, add;
 139
 140                 if (data[--len] == 'C') {
 141                         add = 0;
 142                         celsius = 1;
 143                 } else if (data[len] == 'F') {
 144                         add = -32;
 145                         celsius = 5/9;
 146                 } else if (data[len] == 'K') {
 147                         add = -273.15;
 148                         celsius = 1;
 149                 } else
 150                         return -1;
 151
 152                 while (len > 0 && data[--len] == ' ')
 153                         ;
 154                 data[len + 1] = 0;
 155
 156                 while (len > 0 && data[--len] != ' ')
 157                         ;
 158                 ++len;
 159
 160                 errno = 0;
 161                 temp = (strtod (data + len, &endptr) + add) * celsius;
 162
 163                 if (endptr != data + len && errno == 0) {
 164                         thermal_submit(name, TEMP, temp);
 165                         return 0;
 166                 }
 167         }
 168
 169         return -1;
 170 }
 171
 172 static const char *config_keys[] = {
 173         "Device",
 174         "IgnoreSelected",
 175         "ForceUseProcfs"
 176 };
 177
 178 static int thermal_config (const char *key, const char *value)
 179 {
 180         if (device_list == NULL)
 181                 device_list = ignorelist_create (1);
 182
 183         if (strcasecmp (key, "Device") == 0)
 184         {
 185                 if (ignorelist_add (device_list, value))
 186                 {
 187                         ERROR ("thermal plugin: "
 188                                         "Cannot add value to ignorelist.");
 189                         return 1;
 190                 }
 191         }
 192         else if (strcasecmp (key, "IgnoreSelected") == 0)
 193         {
 194                 ignorelist_set_invert (device_list, 1);
 195                 if ((strcasecmp (value, "True") == 0)
 196                                 || (strcasecmp (value, "Yes") == 0)
 197                                 || (strcasecmp (value, "On") == 0))
 198                         ignorelist_set_invert (device_list, 0);
 199         }
 200         else if (strcasecmp (key, "ForceUseProcfs") == 0)
 201         {
 202                 force_procfs = 0;
 203                 if ((strcasecmp (value, "True") == 0)
 204                                 || (strcasecmp (value, "Yes") == 0)
 205                                 || (strcasecmp (value, "On") == 0))
 206                         force_procfs = 1;
 207         }
 208         else
 209         {
 210                 return -1;
 211         }
 212
 213         return 0;
 214 }
 215
 216 static int thermal_sysfs_read (void)
 217 {
 218         return walk_directory (dirname_sysfs, thermal_sysfs_device_read);
 219 }
 220
 221 static int thermal_procfs_read (void)
 222 {
 223         return walk_directory (dirname_procfs, thermal_procfs_device_read);
 224 }
 225
 226 static int thermal_init (void)
 227 {
 228         int ret = -1;
 229
 230         if (!force_procfs && access (dirname_sysfs, R_OK | X_OK) == 0) {
 231                 ret = plugin_register_read ("thermal", thermal_sysfs_read);
 232         } else if (access (dirname_procfs, R_OK | X_OK) == 0) {
 233                 ret = plugin_register_read ("thermal", thermal_procfs_read);
 234         }
 235
 236         if (!ret) {
 237                 vl_temp_template.values_len = 1;
 238                 vl_temp_template.interval = interval_g;
 239                 sstrncpy (vl_temp_template.host, hostname_g,
 240                         sizeof(vl_temp_template.host));
 241                 sstrncpy (vl_temp_template.plugin, "thermal",
 242                         sizeof(vl_temp_template.plugin));
 243                 sstrncpy (vl_temp_template.type_instance, "temperature",
 244                         sizeof(vl_temp_template.type_instance));
 245
 246                 vl_state_template = vl_temp_template;
 247                 sstrncpy (vl_state_template.type_instance, "cooling_state",
 248                         sizeof(vl_state_template.type_instance));
 249         }
 250
 251         return ret;
 252 }
 253
 254 static int thermal_shutdown (void)
 255 {
 256         ignorelist_free (device_list);
 257
 258         return 0;
 259 }
 260
 261 void module_register (void)
 262 {
 263         plugin_register_config ("thermal", thermal_config,
 264                         config_keys, STATIC_ARRAY_SIZE(config_keys));
 265         plugin_register_init ("thermal", thermal_init);
 266         plugin_register_shutdown ("thermal", thermal_shutdown);
 267 }
 268