Merge branch 'collectd-4.0'
[collectd.git] / src / hddtemp.c
index 64bd300..0432de7 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 "hddtemp.h"
-
-#if COLLECT_HDDTEMP
-#define MODULE_NAME "hddtemp"
-
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
-#include <netinet/tcp.h>
-#include <string.h>
-#include <errno.h>
-#include <syslog.h>
-#include <stdlib.h>
-#include <string.h>
-#include <libgen.h> /* for basename */
-
-#include "plugin.h"
+#include "collectd.h"
 #include "common.h"
+#include "plugin.h"
+#include "configfile.h"
 
-/* LOCALHOST_ADDR
-   The ip address 127.0.0.1, as a 32 bit. */
-#define LOCALHOST_ADDR 0x7F000001
-
-/* HDDTEMP_PORT
-   The tcp port the hddtemp daemon is listening on. */
-#define HDDTEMP_PORT 7634
+# include <netdb.h>
+# include <sys/socket.h>
+# include <netinet/in.h>
+# include <netinet/tcp.h>
+# include <libgen.h> /* for basename */
 
-/* BUFFER_SIZE
-   Size of the buffer we use to receive from the hddtemp daemon. */
-#define BUFFER_SIZE 1024
+#if HAVE_LINUX_MAJOR_H
+# include <linux/major.h>
+#endif
 
-static char *filename_format = "hddtemp-%s.rrd";
+#define HDDTEMP_DEF_HOST "127.0.0.1"
+#define HDDTEMP_DEF_PORT "7634"
 
-static char *ds_def[] =
+static const char *config_keys[] =
 {
-       "DS:value:GAUGE:25:U:U",
+       "Host",
+       "Port",
        NULL
 };
-static int ds_num = 1;
+static int config_keys_num = 2;
 
 typedef struct hddname
 {
@@ -70,87 +61,184 @@ typedef struct hddname
 } hddname_t;
 
 static hddname_t *first_hddname = NULL;
+static char *hddtemp_host = NULL;
+static char hddtemp_port[16];
 
-/* hddtemp_query_daemon
-   Connect to the hddtemp daemon and receive data.
+/*
+ * NAME
+ *  hddtemp_query_daemon
+ *
+ * DESCRIPTION
+ * Connect to the hddtemp daemon and receive data.
+ *
+ * ARGUMENTS:
+ *  `buffer'            The buffer where we put the received ascii string.
+ *  `buffer_size'       Size of the buffer
+ *
+ * RETURN VALUE:
+ *   >= 0 if ok, < 0 otherwise.
+ *
+ * NOTES:
+ *  Example of possible strings, as received from daemon:
+ *    |/dev/hda|ST340014A|36|C|
+ *    |/dev/hda|ST380011A|46|C||/dev/hdd|ST340016A|SLP|*|
+ *
+ * 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 fd;
+       ssize_t status;
+       int buffer_fill;
+
+       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    = 0;
+#ifdef AI_ADDRCONFIG
+       ai_hints.ai_flags   |= AI_ADDRCONFIG;
+#endif
+       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 (strlen (port) == 0)
+               port = HDDTEMP_DEF_PORT;
+
+       if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
+       {
+               char errbuf[1024];
+               ERROR ("hddtemp: getaddrinfo (%s, %s): %s",
+                               host, port,
+                               (ai_return == EAI_SYSTEM)
+                               ? sstrerror (errno, errbuf, sizeof (errbuf))
+                               : gai_strerror (ai_return));
+               return (-1);
+       }
+
+       fd = -1;
+       for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
+       {
+               /* create our socket descriptor */
+               if ((fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol)) < 0)
+               {
+                       char errbuf[1024];
+                       ERROR ("hddtemp: socket: %s",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       continue;
+               }
 
-   Parameters:
-     buffer:      the buffer where we put the received ascii string.
-     buffer_size: size of the buffer
+               /* connect to the hddtemp daemon */
+               if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen))
+               {
+                       char errbuf[1024];
+                       DEBUG ("hddtemp: connect (%s, %s): %s", host, port,
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       close (fd);
+                       fd = -1;
+                       continue;
+               }
 
-   Return value:
-     >= 0 if ok, < 0 otherwise.
+               /* A socket could be opened and connecting succeeded. We're
+                * done. */
+               break;
+       }
 
-   Example of possible strings, as received from daemon:
+       freeaddrinfo (ai_list);
 
-          |/dev/hda|ST340014A|36|C|
-          |/dev/hda|ST380011A|46|C||/dev/hdd|ST340016A|SLP|*|
+       if (fd < 0)
+       {
+               ERROR ("hddtemp: Could not connect to daemon.");
+               return (-1);
+       }
 
-   FIXME: we need to create a new socket each time. Is there another way? */
+       /* receive data from the hddtemp daemon */
+       memset (buffer, '\0', buffer_size);
 
-static int hddtemp_query_daemon (char *buffer, int buffer_size)
-{
-       int sock;
-       ssize_t size;
-       const struct sockaddr_in addr =
+       buffer_fill = 0;
+       while ((status = read (fd, buffer + buffer_fill, buffer_size - buffer_fill)) != 0)
        {
-               AF_INET,                        /* sin_family */
-               htons(HDDTEMP_PORT),            /* sin_port */
-               {                               /* sin_addr */
-                       htonl(LOCALHOST_ADDR),  /* s_addr */
+               if (status == -1)
+               {
+                       char errbuf[1024];
+
+                       if ((errno == EAGAIN) || (errno == EINTR))
+                               continue;
+
+                       ERROR ("hddtemp: Error reading from socket: %s",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       close (fd);
+                       return (-1);
                }
-       };
+               buffer_fill += status;
 
-       /* create our socket descriptor */
-       if ((sock = socket (PF_INET, SOCK_STREAM, 0)) < 0)
-       {
-               syslog (LOG_ERR, "hddtemp: could not create socket: %s", strerror (errno));
-               return (-1);
+               if (buffer_fill >= buffer_size)
+                       break;
        }
 
-       /* connect to the hddtemp daemon */
-       if (connect (sock, (const struct sockaddr *) &addr, sizeof (addr)))
+       if (buffer_fill >= buffer_size)
        {
-               syslog (LOG_ERR, "hddtemp: Could not connect to the hddtemp daemon: %s", strerror (errno));
-               close (sock);
+               buffer[buffer_size - 1] = '\0';
+               WARNING ("hddtemp: Message from hddtemp has been truncated.");
+       }
+       else if (buffer_fill == 0)
+       {
+               WARNING ("hddtemp: Peer has unexpectedly shut down the socket. "
+                               "Buffer: `%s'", buffer);
+               close (fd);
                return (-1);
        }
 
-       /* receive data from the hddtemp daemon */
-       memset (buffer, '\0', buffer_size);
-       size = recv (sock, buffer, buffer_size, 0);
+       close (fd);
+       return (0);
+}
 
-       if (size >= buffer_size)
+static int hddtemp_config (const char *key, const char *value)
+{
+       if (strcasecmp (key, "Host") == 0)
        {
-               syslog (LOG_WARNING, "hddtemp: Message from hddtemp has been truncated.");
-               close (sock);
-               return (-1);
+               if (hddtemp_host != NULL)
+                       free (hddtemp_host);
+               hddtemp_host = strdup (value);
        }
-       /* FIXME: Since the server closes the connection this returns zero. At
-        * least my machine does. -octo */
-       /*
-       else if (size == 0)
+       else if (strcasecmp (key, "Port") == 0)
        {
-               syslog (LOG_WARNING, "hddtemp: Peer has unexpectedly shut down the socket. Buffer: `%s'", buffer);
-               close (sock);
-               return (-1);
+               int port = (int) (atof (value));
+               if ((port > 0) && (port <= 65535))
+                       snprintf (hddtemp_port, sizeof (hddtemp_port),
+                                       "%i", port);
+               else
+                       strncpy (hddtemp_port, value, sizeof (hddtemp_port));
+               hddtemp_port[sizeof (hddtemp_port) - 1] = '\0';
        }
-       */
-       else if (size < 0)
+       else
        {
-               syslog (LOG_ERR, "hddtemp: Could not receive from the hddtemp daemon: %s", strerror (errno));
-               close (sock);
                return (-1);
        }
 
-       close (sock);
        return (0);
 }
 
-static void hddtemp_init (void)
+/* 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 int hddtemp_init (void)
 {
+#if KERNEL_LINUX
        FILE *fh;
-       char buf[BUFFER_SIZE];
+       char buf[1024];
        int buflen;
 
        char *fields[16];
@@ -175,12 +263,21 @@ static void hddtemp_init (void)
 
        if ((fh = fopen ("/proc/partitions", "r")) != NULL)
        {
-               while (fgets (buf, BUFFER_SIZE, fh) != NULL)
+               DEBUG ("Looking at /proc/partitions...");
+
+               while (fgets (buf, sizeof (buf), 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;
                        
@@ -192,23 +289,74 @@ 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:
+                                       DEBUG ("Skipping unknown major %i", major);
+                                       continue;
+                       } /* switch (major) */
 
                        if ((name = strdup (fields[3])) == NULL)
+                       {
+                               ERROR ("hddtemp: strdup(%s) == NULL", fields[3]);
                                continue;
+                       }
 
                        if ((entry = (hddname_t *) malloc (sizeof (hddname_t))) == NULL)
                        {
+                               ERROR ("hddtemp: malloc (%u) == NULL",
+                                               (unsigned int) sizeof (hddname_t));
                                free (name);
                                continue;
                        }
 
+                       DEBUG ("Found disk: %s (%u:%u).", name, major, minor);
+
                        entry->major = major;
                        entry->minor = minor;
                        entry->name  = name;
@@ -224,26 +372,29 @@ static void hddtemp_init (void)
                                first_hddname = entry;
                        }
                }
+               fclose (fh);
        }
+#if COLLECT_DEBUG
+       else
+       {
+               char errbuf[1024];
+               DEBUG ("Could not open /proc/partitions: %s",
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+       }
+#endif /* COLLECT_DEBUG */
+#endif /* KERNEL_LINUX */
 
-       return;
-}
-
-static void hddtemp_write (char *host, char *inst, char *val)
-{
-       char filename[BUFFER_SIZE];
-       int status;
-
-       /* construct filename */
-       status = snprintf (filename, BUFFER_SIZE, filename_format, inst);
-       if (status < 1)
-               return;
-       else if (status >= BUFFER_SIZE)
-               return;
-
-       rrd_update_file (host, filename, val, ds_def, ds_num);
-}
+       return (0);
+} /* int hddtemp_init */
 
+/*
+ * 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;
@@ -254,7 +405,10 @@ static char *hddtemp_get_name (char *drive)
                        break;
 
        if (list == NULL)
+       {
+               DEBUG ("Don't know %s, keeping name as-is.", drive);
                return (strdup (drive));
+       }
 
        if ((ret = (char *) malloc (128 * sizeof (char))) == NULL)
                return (NULL);
@@ -268,59 +422,42 @@ static char *hddtemp_get_name (char *drive)
        return (ret);
 }
 
-static void hddtemp_submit (char *inst, double temperature)
+static void hddtemp_submit (char *type_instance, double value)
 {
-       char buf[BUFFER_SIZE];
+       value_t values[1];
+       value_list_t vl = VALUE_LIST_INIT;
+
+       values[0].gauge = value;
 
-       if (snprintf (buf, BUFFER_SIZE, "%u:%.3f", (unsigned int) curtime, temperature) >= BUFFER_SIZE)
-               return;
+       vl.values = values;
+       vl.values_len = 1;
+       vl.time = time (NULL);
+       strcpy (vl.host, hostname_g);
+       strcpy (vl.plugin, "hddtemp");
+       strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 
-       plugin_submit (MODULE_NAME, inst, buf);
+       plugin_dispatch_values ("temperature", &vl);
 }
 
-static void hddtemp_read (void)
+static int hddtemp_read (void)
 {
-       char buf[BUFFER_SIZE];
+       char buf[1024];
        char *fields[128];
        char *ptr;
+       char *saveptr;
        int num_fields;
        int num_disks;
        int i;
 
-       static int wait_time = 1;
-       static int wait_left = 0;
-
-       if (wait_left >= 10)
-       {
-               wait_left -= 10;
-               return;
-       }
-
        /* get data from daemon */
-       if (hddtemp_query_daemon (buf, BUFFER_SIZE) < 0)
-       {
-               /* This limit is reached in log2(86400) =~ 17 steps. Since
-                * there is a 2^n seconds wait between each step it will need
-                * roughly one day to reach this limit. -octo */
-               
-               wait_time *= 2;
-               if (wait_time > 86400)
-                       wait_time = 86400;
-
-               wait_left = wait_time;
-
-               return;
-       }
-       else
-       {
-               wait_time = 1;
-               wait_left = 0;
-       }
+       if (hddtemp_query_daemon (buf, sizeof (buf)) < 0)
+               return (-1);
 
-       /* NB: strtok will eat up "||" and leading "|"'s */
+       /* NB: strtok_r will eat up "||" and leading "|"'s */
        num_fields = 0;
        ptr = buf;
-       while ((fields[num_fields] = strtok (ptr, "|")) != NULL)
+       saveptr = NULL;
+       while ((fields[num_fields] = strtok_r (ptr, "|", &saveptr)) != NULL)
        {
                ptr = NULL;
                num_fields++;
@@ -338,12 +475,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 */
@@ -360,13 +497,16 @@ static void hddtemp_read (void)
                        hddtemp_submit (name, temperature);
                }
        }
-}
+       
+       return (0);
+} /* int hddtemp_read */
 
 /* module_register
    Register collectd plugin. */
 void module_register (void)
 {
-       plugin_register (MODULE_NAME, hddtemp_init, hddtemp_read, hddtemp_write);
+       plugin_register_config ("hddtemp", hddtemp_config,
+                       config_keys, config_keys_num);
+       plugin_register_init ("hddtemp", hddtemp_init);
+       plugin_register_read ("hddtemp", hddtemp_read);
 }
-
-#endif /* COLLECT_HDDTEMP */