src/hddtemp.c

   1 /**
   2  * collectd - src/hddtemp.c
   3  * Copyright (C) 2005,2006  Vincent Stehlé
   4  * Copyright (C) 2006-2010  Florian octo Forster
   5  * Copyright (C) 2008       Sebastian Harl
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  *
  21  * Authors:
  22  *   Vincent Stehlé <vincent.stehle at free.fr>
  23  *   Florian octo Forster <octo at collectd.org>
  24  *   Sebastian Harl <sh at tokkee.org>
  25  *
  26  * TODO:
  27  *   Do a pass, some day, and spare some memory. We consume too much for now
  28  *   in string buffers and the like.
  29  *
  30  **/
  31
  32 #include "collectd.h"
  33 #include "common.h"
  34 #include "plugin.h"
  35 #include "configfile.h"
  36
  37 # include <netdb.h>
  38 # include <netinet/in.h>
  39 # include <netinet/tcp.h>
  40 # include <libgen.h> /* for basename */
  41
  42 #if HAVE_LINUX_MAJOR_H
  43 # include <linux/major.h>
  44 #endif
  45
  46 #define HDDTEMP_DEF_HOST "127.0.0.1"
  47 #define HDDTEMP_DEF_PORT "7634"
  48
  49 static const char *config_keys[] =
  50 {
  51         "Host",
  52         "Port"
  53 };
  54 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  55
  56 static char *hddtemp_host = NULL;
  57 static char hddtemp_port[16];
  58
  59 /*
  60  * NAME
  61  *  hddtemp_query_daemon
  62  *
  63  * DESCRIPTION
  64  * Connect to the hddtemp daemon and receive data.
  65  *
  66  * ARGUMENTS:
  67  *  `buffer'            The buffer where we put the received ascii string.
  68  *  `buffer_size'       Size of the buffer
  69  *
  70  * RETURN VALUE:
  71  *   >= 0 if ok, < 0 otherwise.
  72  *
  73  * NOTES:
  74  *  Example of possible strings, as received from daemon:
  75  *    |/dev/hda|ST340014A|36|C|
  76  *    |/dev/hda|ST380011A|46|C||/dev/hdd|ST340016A|SLP|*|
  77  *
  78  * FIXME:
  79  *  we need to create a new socket each time. Is there another way?
  80  *  Hm, maybe we can re-use the `sockaddr' structure? -octo
  81  */
  82 static int hddtemp_query_daemon (char *buffer, int buffer_size)
  83 {
  84         int fd;
  85         ssize_t status;
  86         int buffer_fill;
  87
  88         const char *host;
  89         const char *port;
  90
  91         struct addrinfo  ai_hints;
  92         struct addrinfo *ai_list, *ai_ptr;
  93         int              ai_return;
  94
  95         memset (&ai_hints, '\0', sizeof (ai_hints));
  96         ai_hints.ai_flags    = 0;
  97 #ifdef AI_ADDRCONFIG
  98         ai_hints.ai_flags   |= AI_ADDRCONFIG;
  99 #endif
 100         ai_hints.ai_family   = PF_UNSPEC;
 101         ai_hints.ai_socktype = SOCK_STREAM;
 102         ai_hints.ai_protocol = IPPROTO_TCP;
 103
 104         host = hddtemp_host;
 105         if (host == NULL)
 106                 host = HDDTEMP_DEF_HOST;
 107
 108         port = hddtemp_port;
 109         if (strlen (port) == 0)
 110                 port = HDDTEMP_DEF_PORT;
 111
 112         if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
 113         {
 114                 char errbuf[1024];
 115                 ERROR ("hddtemp plugin: getaddrinfo (%s, %s): %s",
 116                                 host, port,
 117                                 (ai_return == EAI_SYSTEM)
 118                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 119                                 : gai_strerror (ai_return));
 120                 return (-1);
 121         }
 122
 123         fd = -1;
 124         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 125         {
 126                 /* create our socket descriptor */
 127                 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
 128                                 ai_ptr->ai_protocol);
 129                 if (fd < 0)
 130                 {
 131                         char errbuf[1024];
 132                         ERROR ("hddtemp plugin: socket: %s",
 133                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 134                         continue;
 135                 }
 136
 137                 /* connect to the hddtemp daemon */
 138                 if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr,
 139                                         ai_ptr->ai_addrlen))
 140                 {
 141                         char errbuf[1024];
 142                         INFO ("hddtemp plugin: connect (%s, %s) failed: %s",
 143                                         host, port,
 144                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 145                         close (fd);
 146                         fd = -1;
 147                         continue;
 148                 }
 149
 150                 /* A socket could be opened and connecting succeeded. We're
 151                  * done. */
 152                 break;
 153         }
 154
 155         freeaddrinfo (ai_list);
 156
 157         if (fd < 0)
 158         {
 159                 ERROR ("hddtemp plugin: Could not connect to daemon.");
 160                 return (-1);
 161         }
 162
 163         /* receive data from the hddtemp daemon */
 164         memset (buffer, '\0', buffer_size);
 165
 166         buffer_fill = 0;
 167         while ((status = read (fd, buffer + buffer_fill, buffer_size - buffer_fill)) != 0)
 168         {
 169                 if (status == -1)
 170                 {
 171                         char errbuf[1024];
 172
 173                         if ((errno == EAGAIN) || (errno == EINTR))
 174                                 continue;
 175
 176                         ERROR ("hddtemp plugin: Error reading from socket: %s",
 177                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 178                         close (fd);
 179                         return (-1);
 180                 }
 181                 buffer_fill += status;
 182
 183                 if (buffer_fill >= buffer_size)
 184                         break;
 185         }
 186
 187         if (buffer_fill >= buffer_size)
 188         {
 189                 buffer[buffer_size - 1] = '\0';
 190                 WARNING ("hddtemp plugin: Message from hddtemp has been "
 191                                 "truncated.");
 192         }
 193         else if (buffer_fill == 0)
 194         {
 195                 WARNING ("hddtemp plugin: Peer has unexpectedly shut down "
 196                                 "the socket. Buffer: `%s'", buffer);
 197                 close (fd);
 198                 return (-1);
 199         }
 200
 201         close (fd);
 202         return (0);
 203 }
 204
 205 static int hddtemp_config (const char *key, const char *value)
 206 {
 207         if (strcasecmp (key, "Host") == 0)
 208         {
 209                 if (hddtemp_host != NULL)
 210                         free (hddtemp_host);
 211                 hddtemp_host = strdup (value);
 212         }
 213         else if (strcasecmp (key, "Port") == 0)
 214         {
 215                 int port = (int) (atof (value));
 216                 if ((port > 0) && (port <= 65535))
 217                         ssnprintf (hddtemp_port, sizeof (hddtemp_port),
 218                                         "%i", port);
 219                 else
 220                         sstrncpy (hddtemp_port, value, sizeof (hddtemp_port));
 221         }
 222         else
 223         {
 224                 return (-1);
 225         }
 226
 227         return (0);
 228 }
 229
 230 static void hddtemp_submit (char *type_instance, double value)
 231 {
 232         value_t values[1];
 233         value_list_t vl = VALUE_LIST_INIT;
 234
 235         values[0].gauge = value;
 236
 237         vl.values = values;
 238         vl.values_len = 1;
 239         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 240         sstrncpy (vl.plugin, "hddtemp", sizeof (vl.plugin));
 241         sstrncpy (vl.type, "temperature", sizeof (vl.type));
 242         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 243
 244         plugin_dispatch_values (&vl);
 245 }
 246
 247 static int hddtemp_read (void)
 248 {
 249         char buf[1024];
 250         char *fields[128];
 251         char *ptr;
 252         char *saveptr;
 253         int num_fields;
 254         int num_disks;
 255         int i;
 256
 257         /* get data from daemon */
 258         if (hddtemp_query_daemon (buf, sizeof (buf)) < 0)
 259                 return (-1);
 260
 261         /* NB: strtok_r will eat up "||" and leading "|"'s */
 262         num_fields = 0;
 263         ptr = buf;
 264         saveptr = NULL;
 265         while ((fields[num_fields] = strtok_r (ptr, "|", &saveptr)) != NULL)
 266         {
 267                 ptr = NULL;
 268                 num_fields++;
 269
 270                 if (num_fields >= 128)
 271                         break;
 272         }
 273
 274         num_disks = num_fields / 4;
 275
 276         for (i = 0; i < num_disks; i++)
 277         {
 278                 char *name;
 279                 double temperature;
 280                 char *mode;
 281
 282                 mode = fields[4*i + 3];
 283                 name = basename (fields[4*i + 0]);
 284
 285                 /* Skip non-temperature information */
 286                 if (mode[0] != 'C' && mode[0] != 'F')
 287                         continue;
 288
 289                 temperature = atof (fields[4*i + 2]);
 290
 291                 /* Convert farenheit to celsius */
 292                 if (mode[0] == 'F')
 293                         temperature = (temperature - 32.0) * 5.0 / 9.0;
 294
 295                 hddtemp_submit (name, temperature);
 296         }
 297
 298         return (0);
 299 } /* int hddtemp_read */
 300
 301 /* module_register
 302    Register collectd plugin. */
 303 void module_register (void)
 304 {
 305         plugin_register_config ("hddtemp", hddtemp_config,
 306                         config_keys, config_keys_num);
 307         plugin_register_read ("hddtemp", hddtemp_read);
 308 }