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