src/hddtemp.c

   1 /**
   2  * collectd - src/hddtemp.c
   3  * Copyright (C) 2005,2006  Vincent Stehlé
   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; either version 2 of the License, or (at your
   8  * option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Vincent Stehlé <vincent.stehle at free.fr>
  21  *   Florian octo Forster <octo at verplant.org>
  22  *
  23  * TODO:
  24  *   Do a pass, some day, and spare some memory. We consume too much for now
  25  *   in string buffers and the like.
  26  *
  27  **/
  28
  29 #include "collectd.h"
  30 #include "common.h"
  31 #include "plugin.h"
  32 #include "configfile.h"
  33
  34 # include <netdb.h>
  35 # include <sys/socket.h>
  36 # include <netinet/in.h>
  37 # include <netinet/tcp.h>
  38 # include <libgen.h> /* for basename */
  39
  40 #if HAVE_LINUX_MAJOR_H
  41 # include <linux/major.h>
  42 #endif
  43
  44 #define HDDTEMP_DEF_HOST "127.0.0.1"
  45 #define HDDTEMP_DEF_PORT "7634"
  46
  47 static const char *config_keys[] =
  48 {
  49         "Host",
  50         "Port",
  51         "TranslateDevicename"
  52 };
  53 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  54
  55 typedef struct hddname
  56 {
  57         int major;
  58         int minor;
  59         char *name;
  60         struct hddname *next;
  61 } hddname_t;
  62
  63 static hddname_t *first_hddname = NULL;
  64 static char *hddtemp_host = NULL;
  65 static char hddtemp_port[16];
  66 static int translate_devicename = 1;
  67
  68 /*
  69  * NAME
  70  *  hddtemp_query_daemon
  71  *
  72  * DESCRIPTION
  73  * Connect to the hddtemp daemon and receive data.
  74  *
  75  * ARGUMENTS:
  76  *  `buffer'            The buffer where we put the received ascii string.
  77  *  `buffer_size'       Size of the buffer
  78  *
  79  * RETURN VALUE:
  80  *   >= 0 if ok, < 0 otherwise.
  81  *
  82  * NOTES:
  83  *  Example of possible strings, as received from daemon:
  84  *    |/dev/hda|ST340014A|36|C|
  85  *    |/dev/hda|ST380011A|46|C||/dev/hdd|ST340016A|SLP|*|
  86  *
  87  * FIXME:
  88  *  we need to create a new socket each time. Is there another way?
  89  *  Hm, maybe we can re-use the `sockaddr' structure? -octo
  90  */
  91 static int hddtemp_query_daemon (char *buffer, int buffer_size)
  92 {
  93         int fd;
  94         ssize_t status;
  95         int buffer_fill;
  96
  97         const char *host;
  98         const char *port;
  99
 100         struct addrinfo  ai_hints;
 101         struct addrinfo *ai_list, *ai_ptr;
 102         int              ai_return;
 103
 104         memset (&ai_hints, '\0', sizeof (ai_hints));
 105         ai_hints.ai_flags    = 0;
 106 #ifdef AI_ADDRCONFIG
 107         ai_hints.ai_flags   |= AI_ADDRCONFIG;
 108 #endif
 109         ai_hints.ai_family   = PF_UNSPEC;
 110         ai_hints.ai_socktype = SOCK_STREAM;
 111         ai_hints.ai_protocol = IPPROTO_TCP;
 112
 113         host = hddtemp_host;
 114         if (host == NULL)
 115                 host = HDDTEMP_DEF_HOST;
 116
 117         port = hddtemp_port;
 118         if (strlen (port) == 0)
 119                 port = HDDTEMP_DEF_PORT;
 120
 121         if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
 122         {
 123                 char errbuf[1024];
 124                 ERROR ("hddtemp: getaddrinfo (%s, %s): %s",
 125                                 host, port,
 126                                 (ai_return == EAI_SYSTEM)
 127                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 128                                 : gai_strerror (ai_return));
 129                 return (-1);
 130         }
 131
 132         fd = -1;
 133         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 134         {
 135                 /* create our socket descriptor */
 136                 if ((fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol)) < 0)
 137                 {
 138                         char errbuf[1024];
 139                         ERROR ("hddtemp: socket: %s",
 140                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 141                         continue;
 142                 }
 143
 144                 /* connect to the hddtemp daemon */
 145                 if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen))
 146                 {
 147                         char errbuf[1024];
 148                         INFO ("hddtemp: connect (%s, %s): %s", host, port,
 149                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 150                         close (fd);
 151                         fd = -1;
 152                         continue;
 153                 }
 154
 155                 /* A socket could be opened and connecting succeeded. We're
 156                  * done. */
 157                 break;
 158         }
 159
 160         freeaddrinfo (ai_list);
 161
 162         if (fd < 0)
 163         {
 164                 ERROR ("hddtemp: Could not connect to daemon.");
 165                 return (-1);
 166         }
 167
 168         /* receive data from the hddtemp daemon */
 169         memset (buffer, '\0', buffer_size);
 170
 171         buffer_fill = 0;
 172         while ((status = read (fd, buffer + buffer_fill, buffer_size - buffer_fill)) != 0)
 173         {
 174                 if (status == -1)
 175                 {
 176                         char errbuf[1024];
 177
 178                         if ((errno == EAGAIN) || (errno == EINTR))
 179                                 continue;
 180
 181                         ERROR ("hddtemp: Error reading from socket: %s",
 182                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 183                         close (fd);
 184                         return (-1);
 185                 }
 186                 buffer_fill += status;
 187
 188                 if (buffer_fill >= buffer_size)
 189                         break;
 190         }
 191
 192         if (buffer_fill >= buffer_size)
 193         {
 194                 buffer[buffer_size - 1] = '\0';
 195                 WARNING ("hddtemp: Message from hddtemp has been truncated.");
 196         }
 197         else if (buffer_fill == 0)
 198         {
 199                 WARNING ("hddtemp: Peer has unexpectedly shut down the socket. "
 200                                 "Buffer: `%s'", buffer);
 201                 close (fd);
 202                 return (-1);
 203         }
 204
 205         close (fd);
 206         return (0);
 207 }
 208
 209 static int hddtemp_config (const char *key, const char *value)
 210 {
 211         if (strcasecmp (key, "Host") == 0)
 212         {
 213                 if (hddtemp_host != NULL)
 214                         free (hddtemp_host);
 215                 hddtemp_host = strdup (value);
 216         }
 217         else if (strcasecmp (key, "Port") == 0)
 218         {
 219                 int port = (int) (atof (value));
 220                 if ((port > 0) && (port <= 65535))
 221                         snprintf (hddtemp_port, sizeof (hddtemp_port),
 222                                         "%i", port);
 223                 else
 224                         strncpy (hddtemp_port, value, sizeof (hddtemp_port));
 225                 hddtemp_port[sizeof (hddtemp_port) - 1] = '\0';
 226         }
 227         else if (strcasecmp (key, "TranslateDevicename") == 0)
 228         {
 229                 if ((strcasecmp ("true", value) == 0)
 230                                 || (strcasecmp ("yes", value) == 0)
 231                                 || (strcasecmp ("on", value) == 0))
 232                         translate_devicename = 1;
 233                 else
 234                         translate_devicename = 0;
 235         }
 236         else
 237         {
 238                 return (-1);
 239         }
 240
 241         return (0);
 242 }
 243
 244 /* In the init-function we initialize the `hddname_t' list used to translate
 245  * disk-names. Under Linux that's done using `/proc/partitions'. Under other
 246  * operating-systems, it's not done at all. */
 247 static int hddtemp_init (void)
 248 {
 249 #if KERNEL_LINUX
 250         FILE *fh;
 251         char buf[1024];
 252         int buflen;
 253
 254         char *fields[16];
 255         int num_fields;
 256
 257         int major;
 258         int minor;
 259         char *name;
 260         hddname_t *next;
 261         hddname_t *entry;
 262
 263         next = first_hddname;
 264         while (next != NULL)
 265         {
 266                 entry = next;
 267                 next = entry->next;
 268
 269                 free (entry->name);
 270                 free (entry);
 271         }
 272         first_hddname = NULL;
 273
 274         if ((fh = fopen ("/proc/partitions", "r")) != NULL)
 275         {
 276                 DEBUG ("Looking at /proc/partitions...");
 277
 278                 while (fgets (buf, sizeof (buf), fh) != NULL)
 279                 {
 280                         /* Delete trailing newlines */
 281                         buflen = strlen (buf);
 282
 283                         while ((buflen > 0) && ((buf[buflen-1] == '\n') || (buf[buflen-1] == '\r')))
 284                                 buf[--buflen] = '\0';
 285
 286                         /* We want lines of the form:
 287                          *
 288                          *     3     1   77842926 hda1
 289                          *
 290                          * ...so, skip everything else. */
 291                         if (buflen == 0)
 292                                 continue;
 293
 294                         num_fields = strsplit (buf, fields, 16);
 295
 296                         if (num_fields != 4)
 297                                 continue;
 298
 299                         major = atoi (fields[0]);
 300                         minor = atoi (fields[1]);
 301
 302                         /* We try to keep only entries, which may correspond to
 303                          * physical disks and that may have a corresponding
 304                          * entry in the hddtemp daemon. Basically, this means
 305                          * IDE and SCSI. */
 306                         switch (major)
 307                         {
 308                                 /* SCSI. */
 309                                 case SCSI_DISK0_MAJOR:
 310                                 case SCSI_DISK1_MAJOR:
 311                                 case SCSI_DISK2_MAJOR:
 312                                 case SCSI_DISK3_MAJOR:
 313                                 case SCSI_DISK4_MAJOR:
 314                                 case SCSI_DISK5_MAJOR:
 315                                 case SCSI_DISK6_MAJOR:
 316                                 case SCSI_DISK7_MAJOR:
 317                                 case SCSI_DISK8_MAJOR:
 318                                 case SCSI_DISK9_MAJOR:
 319                                 case SCSI_DISK10_MAJOR:
 320                                 case SCSI_DISK11_MAJOR:
 321                                 case SCSI_DISK12_MAJOR:
 322                                 case SCSI_DISK13_MAJOR:
 323                                 case SCSI_DISK14_MAJOR:
 324                                 case SCSI_DISK15_MAJOR:
 325                                         /* SCSI disks minors are multiples of 16.
 326                                          * Keep only those. */
 327                                         if (minor % 16)
 328                                                 continue;
 329                                         break;
 330
 331                                 /* IDE. */
 332                                 case IDE0_MAJOR:
 333                                 case IDE1_MAJOR:
 334                                 case IDE2_MAJOR:
 335                                 case IDE3_MAJOR:
 336                                 case IDE4_MAJOR:
 337                                 case IDE5_MAJOR:
 338                                 case IDE6_MAJOR:
 339                                 case IDE7_MAJOR:
 340                                 case IDE8_MAJOR:
 341                                 case IDE9_MAJOR:
 342                                         /* IDE disks minors can only be 0 or 64.
 343                                          * Keep only those. */
 344                                         if(minor != 0 && minor != 64)
 345                                                 continue;
 346                                         break;
 347
 348                                 /* Skip all other majors. */
 349                                 default:
 350                                         DEBUG ("Skipping unknown major %i", major);
 351                                         continue;
 352                         } /* switch (major) */
 353
 354                         if ((name = strdup (fields[3])) == NULL)
 355                         {
 356                                 ERROR ("hddtemp: strdup(%s) == NULL", fields[3]);
 357                                 continue;
 358                         }
 359
 360                         if ((entry = (hddname_t *) malloc (sizeof (hddname_t))) == NULL)
 361                         {
 362                                 ERROR ("hddtemp: malloc (%u) == NULL",
 363                                                 (unsigned int) sizeof (hddname_t));
 364                                 free (name);
 365                                 continue;
 366                         }
 367
 368                         DEBUG ("Found disk: %s (%u:%u).", name, major, minor);
 369
 370                         entry->major = major;
 371                         entry->minor = minor;
 372                         entry->name  = name;
 373                         entry->next  = NULL;
 374
 375                         if (first_hddname == NULL)
 376                         {
 377                                 first_hddname = entry;
 378                         }
 379                         else
 380                         {
 381                                 entry->next = first_hddname;
 382                                 first_hddname = entry;
 383                         }
 384                 }
 385                 fclose (fh);
 386         }
 387 #if COLLECT_DEBUG
 388         else
 389         {
 390                 char errbuf[1024];
 391                 DEBUG ("Could not open /proc/partitions: %s",
 392                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 393         }
 394 #endif /* COLLECT_DEBUG */
 395 #endif /* KERNEL_LINUX */
 396
 397         return (0);
 398 } /* int hddtemp_init */
 399
 400 /*
 401  * hddtemp_get_major_minor
 402  *
 403  * Description:
 404  *   Try to "cook" a bit the drive name as returned
 405  *   by the hddtemp daemon. The intend is to transform disk
 406  *   names into <major>-<minor> when possible.
 407  */
 408 static char *hddtemp_get_major_minor (char *drive)
 409 {
 410         hddname_t *list;
 411         char *ret;
 412
 413         for (list = first_hddname; list != NULL; list = list->next)
 414                 if (strcmp (drive, list->name) == 0)
 415                         break;
 416
 417         if (list == NULL)
 418         {
 419                 DEBUG ("Don't know %s, keeping name as-is.", drive);
 420                 return (strdup (drive));
 421         }
 422
 423         if ((ret = (char *) malloc (128 * sizeof (char))) == NULL)
 424                 return (NULL);
 425
 426         if (snprintf (ret, 128, "%i-%i", list->major, list->minor) >= 128)
 427         {
 428                 free (ret);
 429                 return (NULL);
 430         }
 431
 432         return (ret);
 433 }
 434
 435 static void hddtemp_submit (char *type_instance, double value)
 436 {
 437         value_t values[1];
 438         value_list_t vl = VALUE_LIST_INIT;
 439
 440         values[0].gauge = value;
 441
 442         vl.values = values;
 443         vl.values_len = 1;
 444         vl.time = time (NULL);
 445         strcpy (vl.host, hostname_g);
 446         strcpy (vl.plugin, "hddtemp");
 447         strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 448
 449         plugin_dispatch_values ("temperature", &vl);
 450 }
 451
 452 static int hddtemp_read (void)
 453 {
 454         char buf[1024];
 455         char *fields[128];
 456         char *ptr;
 457         char *saveptr;
 458         int num_fields;
 459         int num_disks;
 460         int i;
 461
 462         /* get data from daemon */
 463         if (hddtemp_query_daemon (buf, sizeof (buf)) < 0)
 464                 return (-1);
 465
 466         /* NB: strtok_r will eat up "||" and leading "|"'s */
 467         num_fields = 0;
 468         ptr = buf;
 469         saveptr = NULL;
 470         while ((fields[num_fields] = strtok_r (ptr, "|", &saveptr)) != NULL)
 471         {
 472                 ptr = NULL;
 473                 num_fields++;
 474
 475                 if (num_fields >= 128)
 476                         break;
 477         }
 478
 479         num_disks = num_fields / 4;
 480
 481         for (i = 0; i < num_disks; i++)
 482         {
 483                 char *name, *major_minor;
 484                 double temperature;
 485                 char *mode;
 486
 487                 mode = fields[4*i + 3];
 488                 name = basename (fields[4*i + 0]);
 489
 490                 /* Skip non-temperature information */
 491                 if (mode[0] != 'C' && mode[0] != 'F')
 492                         continue;
 493
 494                 temperature = atof (fields[4*i + 2]);
 495
 496                 /* Convert farenheit to celsius */
 497                 if (mode[0] == 'F')
 498                         temperature = (temperature - 32.0) * 5.0 / 9.0;
 499
 500                 if (translate_devicename
 501                                 && (major_minor = hddtemp_get_major_minor (name)) != NULL)
 502                 {
 503                         hddtemp_submit (major_minor, temperature);
 504                         free (major_minor);
 505                 }
 506                 else
 507                 {
 508                         hddtemp_submit (name, temperature);
 509                 }
 510         }
 511
 512         return (0);
 513 } /* int hddtemp_read */
 514
 515 /* module_register
 516    Register collectd plugin. */
 517 void module_register (void)
 518 {
 519         plugin_register_config ("hddtemp", hddtemp_config,
 520                         config_keys, config_keys_num);
 521         plugin_register_init ("hddtemp", hddtemp_init);
 522         plugin_register_read ("hddtemp", hddtemp_read);
 523 }