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 read_file_contents (const char *filename, char *buf, int bufsize)
  65 {
  66         FILE *fh;
  67         int n;
  68
  69         if ((fh = fopen (filename, "r")) == NULL)
  70                 return -1;
  71
  72         n = fread(buf, 1, bufsize, fh);
  73         fclose(fh);
  74
  75         return n;
  76 }
  77
  78 static int thermal_sysfs_device_read (const char *name)
  79 {
  80         char filename[256];
  81         char data[1024];
  82         int len;
  83         int ok = 0;
  84
  85         if (device_list && ignorelist_match (device_list, name))
  86                 return -1;
  87
  88         len = snprintf (filename, sizeof (filename), "%s/%s/temp", dirname_sysfs, name);
  89         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
  90                 return -1;
  91
  92         len = read_file_contents (filename, data, sizeof(data));
  93         if (len > 1 && data[--len] == '\n') {
  94                 char *endptr = NULL;
  95                 double temp;
  96
  97                 data[len] = 0;
  98                 errno = 0;
  99                 temp = strtod (data, &endptr) / 1000.0;
 100
 101                 if (endptr == data + len && errno == 0) {
 102                         thermal_submit(name, TEMP, temp);
 103                         ++ok;
 104                 }
 105         }
 106
 107         len = snprintf (filename, sizeof (filename), "%s/%s/cur_state", dirname_sysfs, name);
 108         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
 109                 return -1;
 110
 111         len = read_file_contents (filename, data, sizeof(data));
 112         if (len > 1 && data[--len] == '\n') {
 113                 char *endptr = NULL;
 114                 double state;
 115
 116                 data[len] = 0;
 117                 errno = 0;
 118                 state = strtod (data, &endptr);
 119
 120                 if (endptr == data + len && errno == 0) {
 121                         thermal_submit(name, COOLING_DEV, state);
 122                         ++ok;
 123                 }
 124         }
 125
 126         return ok ? 0 : -1;
 127 }
 128
 129 static int thermal_procfs_device_read (const char *name)
 130 {
 131         const char str_temp[] = "temperature:";
 132         char filename[256];
 133         char data[1024];
 134         int len;
 135
 136         if (device_list && ignorelist_match (device_list, name))
 137                 return -1;
 138
 139         /**
 140          * rechot ~ # cat /proc/acpi/thermal_zone/THRM/temperature
 141          * temperature:             55 C
 142          */
 143
 144         len = snprintf (filename, sizeof (filename), "%s/%s/temperature", dirname_procfs, name);
 145         if ((len < 0) || ((unsigned int)len >= sizeof (filename)))
 146                 return -1;
 147
 148         len = read_file_contents (filename, data, sizeof(data));
 149         if (len > sizeof(str_temp) && data[--len] == '\n' && !strncmp(data, str_temp, sizeof(str_temp)-1)) {
 150                 char *endptr = NULL;
 151                 double temp;
 152                 double celsius, add;
 153
 154                 if (data[--len] == 'C') {
 155                         add = 0;
 156                         celsius = 1;
 157                 } else if (data[len] == 'F') {
 158                         add = -32;
 159                         celsius = 5/9;
 160                 } else if (data[len] == 'K') {
 161                         add = -273.15;
 162                         celsius = 1;
 163                 } else
 164                         return -1;
 165
 166                 while (len > 0 && data[--len] == ' ')
 167                         ;
 168                 data[len + 1] = 0;
 169
 170                 while (len > 0 && data[--len] != ' ')
 171                         ;
 172                 ++len;
 173
 174                 errno = 0;
 175                 temp = (strtod (data + len, &endptr) + add) * celsius;
 176
 177                 if (endptr != data + len && errno == 0) {
 178                         thermal_submit(name, TEMP, temp);
 179                         return 0;
 180                 }
 181         }
 182
 183         return -1;
 184 }
 185
 186 static const char *config_keys[] = {
 187         "Device",
 188         "IgnoreSelected",
 189         "ForceUseProcfs"
 190 };
 191
 192 static int thermal_config (const char *key, const char *value)
 193 {
 194         if (device_list == NULL)
 195                 device_list = ignorelist_create (1);
 196
 197         if (strcasecmp (key, "Device") == 0)
 198         {
 199                 if (ignorelist_add (device_list, value))
 200                 {
 201                         ERROR ("thermal plugin: "
 202                                         "Cannot add value to ignorelist.");
 203                         return 1;
 204                 }
 205         }
 206         else if (strcasecmp (key, "IgnoreSelected") == 0)
 207         {
 208                 ignorelist_set_invert (device_list, 1);
 209                 if ((strcasecmp (value, "True") == 0)
 210                                 || (strcasecmp (value, "Yes") == 0)
 211                                 || (strcasecmp (value, "On") == 0))
 212                         ignorelist_set_invert (device_list, 0);
 213         }
 214         else if (strcasecmp (key, "ForceUseProcfs") == 0)
 215         {
 216                 force_procfs = 0;
 217                 if ((strcasecmp (value, "True") == 0)
 218                                 || (strcasecmp (value, "Yes") == 0)
 219                                 || (strcasecmp (value, "On") == 0))
 220                         force_procfs = 1;
 221         }
 222         else
 223         {
 224                 return -1;
 225         }
 226
 227         return 0;
 228 }
 229
 230 static int thermal_sysfs_read (void)
 231 {
 232         return walk_directory (dirname_sysfs, thermal_sysfs_device_read);
 233 }
 234
 235 static int thermal_procfs_read (void)
 236 {
 237         return walk_directory (dirname_procfs, thermal_procfs_device_read);
 238 }
 239
 240 static int thermal_init (void)
 241 {
 242         int ret = -1;
 243
 244         if (!force_procfs && access (dirname_sysfs, R_OK | X_OK) == 0) {
 245                 ret = plugin_register_read ("thermal", thermal_sysfs_read);
 246         } else if (access (dirname_procfs, R_OK | X_OK) == 0) {
 247                 ret = plugin_register_read ("thermal", thermal_procfs_read);
 248         }
 249
 250         if (!ret) {
 251                 vl_temp_template.values_len = 1;
 252                 vl_temp_template.interval = interval_g;
 253                 sstrncpy (vl_temp_template.host, hostname_g,
 254                         sizeof(vl_temp_template.host));
 255                 sstrncpy (vl_temp_template.plugin, "thermal",
 256                         sizeof(vl_temp_template.plugin));
 257                 sstrncpy (vl_temp_template.type_instance, "temperature",
 258                         sizeof(vl_temp_template.type_instance));
 259
 260                 vl_state_template = vl_temp_template;
 261                 sstrncpy (vl_state_template.type_instance, "cooling_state",
 262                         sizeof(vl_state_template.type_instance));
 263         }
 264
 265         return ret;
 266 }
 267
 268 static int thermal_shutdown (void)
 269 {
 270         ignorelist_free (device_list);
 271
 272         return 0;
 273 }
 274
 275 void module_register (void)
 276 {
 277         plugin_register_config ("thermal", thermal_config,
 278                         config_keys, STATIC_ARRAY_SIZE(config_keys));
 279         plugin_register_init ("thermal", thermal_init);
 280         plugin_register_shutdown ("thermal", thermal_shutdown);
 281 }
 282