{GPL, other}: Relicense to MIT license.
[collectd.git] / src / hddtemp.c
index 08bbbc0..82c158c 100644 (file)
@@ -1,6 +1,8 @@
 /**
  * collectd - src/hddtemp.c
  * Copyright (C) 2005,2006  Vincent StehlĂ©
+ * Copyright (C) 2006-2010  Florian octo Forster
+ * Copyright (C) 2008       Sebastian Harl
  *
  * 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
@@ -18,7 +20,8 @@
  *
  * Authors:
  *   Vincent StehlĂ© <vincent.stehle at free.fr>
- *   Florian octo Forster <octo at verplant.org>
+ *   Florian octo Forster <octo at collectd.org>
+ *   Sebastian Harl <sh at tokkee.org>
  *
  * TODO:
  *   Do a pass, some day, and spare some memory. We consume too much for now
 #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 */
+# include <netdb.h>
+# include <sys/socket.h>
+# include <netinet/in.h>
+# include <netinet/tcp.h>
+# include <libgen.h> /* for basename */
 
 #if HAVE_LINUX_MAJOR_H
 # include <linux/major.h>
 #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. */
-#define BUFFER_SIZE 1024
-
-static char *filename_format = "hddtemp-%s.rrd";
-
-static char *ds_def[] =
-{
-       "DS:value:GAUGE:"COLLECTD_HEARTBEAT":U:U",
-       NULL
-};
-static int ds_num = 1;
-
-static char *config_keys[] =
+static const char *config_keys[] =
 {
        "Host",
-       "Port",
-       NULL
+       "Port"
 };
-static int config_keys_num = 2;
-
-typedef struct hddname
-{
-       int major;
-       int minor;
-       char *name;
-       struct hddname *next;
-} hddname_t;
+static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 
-static hddname_t *first_hddname = NULL;
 static char *hddtemp_host = NULL;
-static char *hddtemp_port = NULL;
+static char hddtemp_port[16];
 
 /*
  * NAME
@@ -117,7 +94,10 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
        int              ai_return;
 
        memset (&ai_hints, '\0', sizeof (ai_hints));
-       ai_hints.ai_flags    = AI_ADDRCONFIG;
+       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;
@@ -127,14 +107,17 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
                host = HDDTEMP_DEF_HOST;
 
        port = hddtemp_port;
-       if (port == NULL)
+       if (strlen (port) == 0)
                port = HDDTEMP_DEF_PORT;
 
        if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0)
        {
-               syslog (LOG_ERR, "hddtemp: getaddrinfo (%s, %s): %s",
+               char errbuf[1024];
+               ERROR ("hddtemp plugin: getaddrinfo (%s, %s): %s",
                                host, port,
-                               ai_return == EAI_SYSTEM ? strerror (errno) : gai_strerror (ai_return));
+                               (ai_return == EAI_SYSTEM)
+                               ? sstrerror (errno, errbuf, sizeof (errbuf))
+                               : gai_strerror (ai_return));
                return (-1);
        }
 
@@ -142,18 +125,24 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
        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)
+               fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
+                               ai_ptr->ai_protocol);
+               if (fd < 0)
                {
-                       syslog (LOG_ERR, "hddtemp: socket: %s",
-                                       strerror (errno));
+                       char errbuf[1024];
+                       ERROR ("hddtemp plugin: socket: %s",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
                        continue;
                }
 
                /* connect to the hddtemp daemon */
-               if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen))
+               if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr,
+                                       ai_ptr->ai_addrlen))
                {
-                       DBG ("hddtemp: connect (%s, %s): %s", host, port,
-                                       strerror (errno));
+                       char errbuf[1024];
+                       INFO ("hddtemp plugin: connect (%s, %s) failed: %s",
+                                       host, port,
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
                        close (fd);
                        fd = -1;
                        continue;
@@ -168,7 +157,7 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
 
        if (fd < 0)
        {
-               syslog (LOG_ERR, "hddtemp: Could not connect to daemon.");
+               ERROR ("hddtemp plugin: Could not connect to daemon.");
                return (-1);
        }
 
@@ -180,11 +169,14 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
        {
                if (status == -1)
                {
+                       char errbuf[1024];
+
                        if ((errno == EAGAIN) || (errno == EINTR))
                                continue;
 
-                       syslog (LOG_ERR, "hddtemp: Error reading from socket: %s",
-                                               strerror (errno));
+                       ERROR ("hddtemp plugin: Error reading from socket: %s",
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       close (fd);
                        return (-1);
                }
                buffer_fill += status;
@@ -196,12 +188,13 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
        if (buffer_fill >= buffer_size)
        {
                buffer[buffer_size - 1] = '\0';
-               syslog (LOG_WARNING, "hddtemp: Message from hddtemp has been truncated.");
+               WARNING ("hddtemp plugin: Message from hddtemp has been "
+                               "truncated.");
        }
        else if (buffer_fill == 0)
        {
-               syslog (LOG_WARNING, "hddtemp: Peer has unexpectedly shut down the socket. "
-                               "Buffer: `%s'", buffer);
+               WARNING ("hddtemp plugin: Peer has unexpectedly shut down "
+                               "the socket. Buffer: `%s'", buffer);
                close (fd);
                return (-1);
        }
@@ -210,19 +203,22 @@ static int hddtemp_query_daemon (char *buffer, int buffer_size)
        return (0);
 }
 
-static int hddtemp_config (char *key, char *value)
+static int hddtemp_config (const char *key, const char *value)
 {
-       if (strcasecmp (key, "host") == 0)
+       if (strcasecmp (key, "Host") == 0)
        {
                if (hddtemp_host != NULL)
                        free (hddtemp_host);
                hddtemp_host = strdup (value);
        }
-       else if (strcasecmp (key, "port") == 0)
+       else if (strcasecmp (key, "Port") == 0)
        {
-               if (hddtemp_port != NULL)
-                       free (hddtemp_port);
-               hddtemp_port = strdup (value);
+               int port = (int) (atof (value));
+               if ((port > 0) && (port <= 65535))
+                       ssnprintf (hddtemp_port, sizeof (hddtemp_port),
+                                       "%i", port);
+               else
+                       sstrncpy (hddtemp_port, value, sizeof (hddtemp_port));
        }
        else
        {
@@ -232,258 +228,42 @@ static int hddtemp_config (char *key, char *value)
        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;
-
-       char *fields[16];
-       int num_fields;
-
-       int major;
-       int minor;
-       char *name;
-       hddname_t *next;
-       hddname_t *entry;
-
-       next = first_hddname;
-       while (next != NULL)
-       {
-               entry = next;
-               next = entry->next;
-
-               free (entry->name);
-               free (entry);
-       }
-       first_hddname = NULL;
-
-       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;
-                       
-                       num_fields = strsplit (buf, fields, 16);
-
-                       if (num_fields != 4)
-                               continue;
-
-                       major = atoi (fields[0]);
-                       minor = atoi (fields[1]);
-
-                       /* 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",
-                                               (unsigned int) sizeof (hddname_t));
-                               free (name);
-                               continue;
-                       }
-
-                       DBG ("Found disk: %s (%u:%u).", name, major, minor);
-
-                       entry->major = major;
-                       entry->minor = minor;
-                       entry->name  = name;
-                       entry->next  = NULL;
-
-                       if (first_hddname == NULL)
-                       {
-                               first_hddname = entry;
-                       }
-                       else
-                       {
-                               entry->next = first_hddname;
-                               first_hddname = entry;
-                       }
-               }
-       }
-       else
-               DBG ("Could not open /proc/partitions: %s",
-                               strerror (errno));
-#endif /* KERNEL_LINUX */
-}
-
-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);
-}
-
-/*
- * 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)
+static void hddtemp_submit (char *type_instance, double value)
 {
-       hddname_t *list;
-       char *ret;
-
-       for (list = first_hddname; list != NULL; list = list->next)
-               if (strcmp (drive, list->name) == 0)
-                       break;
+       value_t values[1];
+       value_list_t vl = VALUE_LIST_INIT;
 
-       if (list == NULL)
-       {
-               DBG ("Don't know %s, keeping name as-is.", drive);
-               return (strdup (drive));
-       }
+       values[0].gauge = value;
 
-       if ((ret = (char *) malloc (128 * sizeof (char))) == NULL)
-               return (NULL);
+       vl.values = values;
+       vl.values_len = 1;
+       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.plugin, "hddtemp", sizeof (vl.plugin));
+       sstrncpy (vl.type, "temperature", sizeof (vl.type));
+       sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 
-       if (snprintf (ret, 128, "%i-%i", list->major, list->minor) >= 128)
-       {
-               free (ret);
-               return (NULL);
-       }
-
-       return (ret);
+       plugin_dispatch_values (&vl);
 }
 
-static void hddtemp_submit (char *inst, double temperature)
+static int hddtemp_read (void)
 {
-       char buf[BUFFER_SIZE];
-
-       if (snprintf (buf, BUFFER_SIZE, "%u:%.3f", (unsigned int) curtime, temperature)
-            >= BUFFER_SIZE)
-               return;
-
-       plugin_submit (MODULE_NAME, inst, buf);
-}
-
-static void 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++;
@@ -496,7 +276,7 @@ static void hddtemp_read (void)
 
        for (i = 0; i < num_disks; i++)
        {
-               char *name, *submit_name;
+               char *name;
                double temperature;
                char *mode;
 
@@ -513,24 +293,17 @@ static void hddtemp_read (void)
                if (mode[0] == 'F')
                        temperature = (temperature - 32.0) * 5.0 / 9.0;
 
-               if ((submit_name = hddtemp_get_name (name)) != NULL)
-               {
-                       hddtemp_submit (submit_name, temperature);
-                       free (submit_name);
-               }
-               else
-               {
-                       hddtemp_submit (name, temperature);
-               }
+               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);
-       cf_register (MODULE_NAME, hddtemp_config, config_keys, config_keys_num);
+       plugin_register_config ("hddtemp", hddtemp_config,
+                       config_keys, config_keys_num);
+       plugin_register_read ("hddtemp", hddtemp_read);
 }
-
-#undef MODULE_NAME