Merged revisions 581 and 583 from trunk to tags/collectd-3.8.4
[collectd.git] / src / hddtemp.c
index cfa7b8f..bba96d8 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/hddtemp.c
- * Copyright (C) 2005  Vincent Stehlé
+ * Copyright (C) 2005-2006  Vincent Stehlé
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
  * Authors:
  *   Vincent Stehlé <vincent.stehle at free.fr>
  *   Florian octo Forster <octo at verplant.org>
+ *
+ * TODO:
+ *   Do a pass, some day, and spare some memory. We consume too much for now
+ *   in string buffers and the like.
+ *
  **/
 
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
+#include "configfile.h"
+#include "utils_debug.h"
 
 #define MODULE_NAME "hddtemp"
 
+#include <netdb.h>
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <netinet/tcp.h>
 #include <libgen.h> /* for basename */
 
-/* LOCALHOST_ADDR
-   The ip address 127.0.0.1, as a 32 bit. */
-#define LOCALHOST_ADDR 0x7F000001
+#if HAVE_LINUX_MAJOR_H
+# include <linux/major.h>
+#endif
 
-/* HDDTEMP_PORT
-   The tcp port the hddtemp daemon is listening on. */
-#define HDDTEMP_PORT 7634
+#define HDDTEMP_DEF_HOST "127.0.0.1"
+#define HDDTEMP_DEF_PORT "7634"
 
 /* BUFFER_SIZE
    Size of the buffer we use to receive from the hddtemp daemon. */
@@ -53,6 +60,14 @@ static char *ds_def[] =
 };
 static int ds_num = 1;
 
+static char *config_keys[] =
+{
+       "Host",
+       "Port",
+       NULL
+};
+static int config_keys_num = 2;
+
 typedef struct hddname
 {
        int major;
@@ -62,6 +77,8 @@ typedef struct hddname
 } hddname_t;
 
 static hddname_t *first_hddname = NULL;
+static char *hddtemp_host = NULL;
+static char *hddtemp_port = NULL;
 
 /*
  * NAME
@@ -84,68 +101,139 @@ static hddname_t *first_hddname = NULL;
  *
  * FIXME:
  *  we need to create a new socket each time. Is there another way?
+ *  Hm, maybe we can re-use the `sockaddr' structure? -octo
  */
 static int hddtemp_query_daemon (char *buffer, int buffer_size)
 {
-       int sock;
-       ssize_t size;
-       const struct sockaddr_in addr =
-       {
-               AF_INET,                        /* sin_family */
-               htons(HDDTEMP_PORT),            /* sin_port */
-               {                               /* sin_addr */
-                       htonl(LOCALHOST_ADDR),  /* s_addr */
-               }
-       };
+       int fd;
+       ssize_t status;
+       int buffer_fill;
 
-       /* create our socket descriptor */
-       if ((sock = socket (PF_INET, SOCK_STREAM, 0)) < 0)
+       const char *host;
+       const char *port;
+
+       struct addrinfo  ai_hints;
+       struct addrinfo *ai_list, *ai_ptr;
+       int              ai_return;
+
+       memset (&ai_hints, '\0', sizeof (ai_hints));
+       ai_hints.ai_flags    = AI_ADDRCONFIG;
+       ai_hints.ai_family   = PF_UNSPEC;
+       ai_hints.ai_socktype = SOCK_STREAM;
+       ai_hints.ai_protocol = IPPROTO_TCP;
+
+       host = hddtemp_host;
+       if (host == NULL)
+               host = HDDTEMP_DEF_HOST;
+
+       port = hddtemp_port;
+       if (port == NULL)
+               port = HDDTEMP_DEF_PORT;
+
+       if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
        {
-               syslog (LOG_ERR, "hddtemp: could not create socket: %s", strerror (errno));
+               syslog (LOG_ERR, "hddtemp: getaddrinfo (%s, %s): %s",
+                               host, port,
+                               ai_return == EAI_SYSTEM ? strerror (errno) : gai_strerror (ai_return));
                return (-1);
        }
 
-       /* connect to the hddtemp daemon */
-       if (connect (sock, (const struct sockaddr *) &addr, sizeof (addr)))
+       fd = -1;
+       for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
        {
-               syslog (LOG_ERR, "hddtemp: Could not connect to the hddtemp daemon: %s", strerror (errno));
-               close (sock);
+               /* create our socket descriptor */
+               if ((fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol)) < 0)
+               {
+                       syslog (LOG_ERR, "hddtemp: socket: %s",
+                                       strerror (errno));
+                       continue;
+               }
+
+               /* connect to the hddtemp daemon */
+               if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen))
+               {
+                       DBG ("hddtemp: connect (%s, %s): %s", host, port,
+                                       strerror (errno));
+                       close (fd);
+                       fd = -1;
+                       continue;
+               }
+       }
+
+       freeaddrinfo (ai_list);
+
+       if (fd < 0)
+       {
+               syslog (LOG_ERR, "hddtemp: Could not connect to daemon.");
                return (-1);
        }
 
        /* receive data from the hddtemp daemon */
        memset (buffer, '\0', buffer_size);
-       size = recv (sock, buffer, buffer_size, 0);
 
-       if (size >= buffer_size)
+       buffer_fill = 0;
+       while ((status = read (fd, buffer + buffer_fill, buffer_size - buffer_fill)) != 0)
+       {
+               if (status == -1)
+               {
+                       if ((errno == EAGAIN) || (errno == EINTR))
+                               continue;
+
+                       syslog (LOG_ERR, "hddtemp: Error reading from socket: %s",
+                                               strerror (errno));
+                       return (-1);
+               }
+               buffer_fill += status;
+
+               if (buffer_fill >= buffer_size)
+                       break;
+       }
+
+       if (buffer_fill >= buffer_size)
        {
+               buffer[buffer_size - 1] = '\0';
                syslog (LOG_WARNING, "hddtemp: Message from hddtemp has been truncated.");
-               close (sock);
-               return (-1);
        }
-       /* FIXME: Since the server closes the connection this returns zero. At
-        * least my machine does. -octo */
-       /*
-       else if (size == 0)
+       else if (buffer_fill == 0)
        {
-               syslog (LOG_WARNING, "hddtemp: Peer has unexpectedly shut down the socket. Buffer: `%s'", buffer);
-               close (sock);
+               syslog (LOG_WARNING, "hddtemp: Peer has unexpectedly shut down the socket. "
+                               "Buffer: `%s'", buffer);
+               close (fd);
                return (-1);
        }
-       */
-       else if (size < 0)
+
+       close (fd);
+       return (0);
+}
+
+static int hddtemp_config (char *key, char *value)
+{
+       if (strcasecmp (key, "host") == 0)
+       {
+               if (hddtemp_host != NULL)
+                       free (hddtemp_host);
+               hddtemp_host = strdup (value);
+       }
+       else if (strcasecmp (key, "port") == 0)
+       {
+               if (hddtemp_port != NULL)
+                       free (hddtemp_port);
+               hddtemp_port = strdup (value);
+       }
+       else
        {
-               syslog (LOG_ERR, "hddtemp: Could not receive from the hddtemp daemon: %s", strerror (errno));
-               close (sock);
                return (-1);
        }
 
-       close (sock);
        return (0);
 }
 
+/* In the init-function we initialize the `hddname_t' list used to translate
+ * disk-names. Under Linux that's done using `/proc/partitions'. Under other
+ * operating-systems, it's not done at all. */
 static void hddtemp_init (void)
 {
+#if KERNEL_LINUX
        FILE *fh;
        char buf[BUFFER_SIZE];
        int buflen;
@@ -172,12 +260,21 @@ static void hddtemp_init (void)
 
        if ((fh = fopen ("/proc/partitions", "r")) != NULL)
        {
+               DBG ("Looking at /proc/partitions...");
+
                while (fgets (buf, BUFFER_SIZE, fh) != NULL)
                {
                        /* Delete trailing newlines */
                        buflen = strlen (buf);
+
                        while ((buflen > 0) && ((buf[buflen-1] == '\n') || (buf[buflen-1] == '\r')))
                                buf[--buflen] = '\0';
+
+                       /* We want lines of the form:
+                        *
+                        *     3     1   77842926 hda1
+                        *
+                        * ...so, skip everything else. */
                        if (buflen == 0)
                                continue;
                        
@@ -189,23 +286,73 @@ static void hddtemp_init (void)
                        major = atoi (fields[0]);
                        minor = atoi (fields[1]);
 
-                       /* I know that this makes `minor' redundant, but I want
-                        * to be able to change this beavior in the future..
-                        * And 4 or 8 bytes won't hurt anybody.. -octo */
-                       if (major == 0)
-                               continue;
-                       if (minor != 0)
-                               continue;
+                       /* We try to keep only entries, which may correspond to
+                        * physical disks and that may have a corresponding
+                        * entry in the hddtemp daemon. Basically, this means
+                        * IDE and SCSI. */
+                       switch (major)
+                       {
+                               /* SCSI. */
+                               case SCSI_DISK0_MAJOR:
+                               case SCSI_DISK1_MAJOR:
+                               case SCSI_DISK2_MAJOR:
+                               case SCSI_DISK3_MAJOR:
+                               case SCSI_DISK4_MAJOR:
+                               case SCSI_DISK5_MAJOR:
+                               case SCSI_DISK6_MAJOR:
+                               case SCSI_DISK7_MAJOR:
+                               case SCSI_DISK8_MAJOR:
+                               case SCSI_DISK9_MAJOR:
+                               case SCSI_DISK10_MAJOR:
+                               case SCSI_DISK11_MAJOR:
+                               case SCSI_DISK12_MAJOR:
+                               case SCSI_DISK13_MAJOR:
+                               case SCSI_DISK14_MAJOR:
+                               case SCSI_DISK15_MAJOR:
+                                       /* SCSI disks minors are multiples of 16.
+                                        * Keep only those. */
+                                       if (minor % 16)
+                                               continue;
+                                       break;
+
+                               /* IDE. */
+                               case IDE0_MAJOR:
+                               case IDE1_MAJOR:
+                               case IDE2_MAJOR:
+                               case IDE3_MAJOR:
+                               case IDE4_MAJOR:
+                               case IDE5_MAJOR:
+                               case IDE6_MAJOR:
+                               case IDE7_MAJOR:
+                               case IDE8_MAJOR:
+                               case IDE9_MAJOR:
+                                       /* IDE disks minors can only be 0 or 64.
+                                        * Keep only those. */
+                                       if(minor != 0 && minor != 64)
+                                               continue;
+                                       break;
+
+                               /* Skip all other majors. */
+                               default:
+                                       DBG ("Skipping unknown major %i", major);
+                                       continue;
+                       } /* switch (major) */
 
                        if ((name = strdup (fields[3])) == NULL)
+                       {
+                               syslog (LOG_ERR, "hddtemp: strdup(%s) == NULL", fields[3]);
                                continue;
+                       }
 
                        if ((entry = (hddname_t *) malloc (sizeof (hddname_t))) == NULL)
                        {
+                               syslog (LOG_ERR, "hddtemp: malloc (%u) == NULL", sizeof (hddname_t));
                                free (name);
                                continue;
                        }
 
+                       DBG ("Found disk: %s (%u:%u).", name, major, minor);
+
                        entry->major = major;
                        entry->minor = minor;
                        entry->name  = name;
@@ -222,8 +369,10 @@ static void hddtemp_init (void)
                        }
                }
        }
-
-       return;
+       else
+               DBG ("Could not open /proc/partitions: %s",
+                               strerror (errno));
+#endif /* KERNEL_LINUX */
 }
 
 static void hddtemp_write (char *host, char *inst, char *val)
@@ -241,6 +390,14 @@ static void hddtemp_write (char *host, char *inst, char *val)
        rrd_update_file (host, filename, val, ds_def, ds_num);
 }
 
+/*
+ * hddtemp_get_name
+ *
+ * Description:
+ *   Try to "cook" a bit the drive name as returned
+ *   by the hddtemp daemon. The intend is to transform disk
+ *   names into <major>-<minor> when possible.
+ */
 static char *hddtemp_get_name (char *drive)
 {
        hddname_t *list;
@@ -251,7 +408,10 @@ static char *hddtemp_get_name (char *drive)
                        break;
 
        if (list == NULL)
+       {
+               DBG ("Don't know %s, keeping name as-is.", drive);
                return (strdup (drive));
+       }
 
        if ((ret = (char *) malloc (128 * sizeof (char))) == NULL)
                return (NULL);
@@ -269,7 +429,8 @@ static void hddtemp_submit (char *inst, double temperature)
 {
        char buf[BUFFER_SIZE];
 
-       if (snprintf (buf, BUFFER_SIZE, "%u:%.3f", (unsigned int) curtime, temperature) >= BUFFER_SIZE)
+       if (snprintf (buf, BUFFER_SIZE, "%u:%.3f", (unsigned int) curtime, temperature)
+            >= BUFFER_SIZE)
                return;
 
        plugin_submit (MODULE_NAME, inst, buf);
@@ -335,12 +496,12 @@ static void hddtemp_read (void)
                char *mode;
 
                mode = fields[4*i + 3];
+               name = basename (fields[4*i + 0]);
 
                /* Skip non-temperature information */
                if (mode[0] != 'C' && mode[0] != 'F')
                        continue;
 
-               name = basename (fields[4*i + 0]);
                temperature = atof (fields[4*i + 2]);
 
                /* Convert farenheit to celsius */
@@ -364,6 +525,7 @@ static void hddtemp_read (void)
 void module_register (void)
 {
        plugin_register (MODULE_NAME, hddtemp_init, hddtemp_read, hddtemp_write);
+       cf_register (MODULE_NAME, hddtemp_config, config_keys, config_keys_num);
 }
 
 #undef MODULE_NAME