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