Tree wide: Reformat with clang-format.
[collectd.git] / src / hddtemp.c
index 64bd300..321c165 100644 (file)
@@ -1,6 +1,9 @@
 /**
  * collectd - src/hddtemp.c
- * Copyright (C) 2005  Vincent Stehlé
+ * Copyright (C) 2005,2006  Vincent Stehlé
+ * Copyright (C) 2006-2010  Florian octo Forster
+ * Copyright (C) 2008       Sebastian Harl
+ * Copyright (C) 2014       Carnegie Mellon University
  *
  * 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>
+ *   Florian octo Forster <octo at collectd.org>
+ *   Sebastian Harl <sh at tokkee.org>
+ *   Benjamin Gilbert <bgilbert at backtick.net>
+ *
+ * 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"
+#include "collectd.h"
 
-#if COLLECT_HDDTEMP
-#define MODULE_NAME "hddtemp"
+#include "common.h"
+#include "plugin.h"
 
-#include <sys/types.h>
-#include <sys/socket.h>
+#include <assert.h>
+#include <libgen.h> /* for basename */
+#include <netdb.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 "common.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
-
-/* 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:25:U:U",
-       NULL
-};
-static int ds_num = 1;
-
-typedef struct hddname
-{
-       int major;
-       int minor;
-       char *name;
-       struct hddname *next;
-} hddname_t;
-
-static hddname_t *first_hddname = NULL;
-
-/* hddtemp_query_daemon
-   Connect to the hddtemp daemon and receive data.
-
-   Parameters:
-     buffer:      the buffer where we put the received ascii string.
-     buffer_size: size of the buffer
-
-   Return value:
-     >= 0 if ok, < 0 otherwise.
-
-   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? */
-
-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 */
-               }
-       };
-
-       /* 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);
-       }
-
-       /* connect to the hddtemp daemon */
-       if (connect (sock, (const struct sockaddr *) &addr, sizeof (addr)))
-       {
-               syslog (LOG_ERR, "hddtemp: Could not connect to the hddtemp daemon: %s", strerror (errno));
-               close (sock);
-               return (-1);
-       }
-
-       /* receive data from the hddtemp daemon */
-       memset (buffer, '\0', buffer_size);
-       size = recv (sock, buffer, buffer_size, 0);
-
-       if (size >= buffer_size)
-       {
-               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)
-       {
-               syslog (LOG_WARNING, "hddtemp: Peer has unexpectedly shut down the socket. Buffer: `%s'", buffer);
-               close (sock);
-               return (-1);
-       }
-       */
-       else if (size < 0)
-       {
-               syslog (LOG_ERR, "hddtemp: Could not receive from the hddtemp daemon: %s", strerror (errno));
-               close (sock);
-               return (-1);
-       }
-
-       close (sock);
-       return (0);
-}
+#if HAVE_LINUX_MAJOR_H
+#include <linux/major.h>
+#endif
 
-static void hddtemp_init (void)
-{
-       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)
-       {
-               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';
-                       if (buflen == 0)
-                               continue;
-                       
-                       num_fields = strsplit (buf, fields, 16);
-
-                       if (num_fields != 4)
-                               continue;
-
-                       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;
-
-                       if ((name = strdup (fields[3])) == NULL)
-                               continue;
-
-                       if ((entry = (hddname_t *) malloc (sizeof (hddname_t))) == NULL)
-                       {
-                               free (name);
-                               continue;
-                       }
-
-                       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;
-                       }
-               }
-       }
-
-       return;
-}
+#define HDDTEMP_DEF_HOST "127.0.0.1"
+#define HDDTEMP_DEF_PORT "7634"
+#define HDDTEMP_MAX_RECV_BUF (1 << 20)
 
-static void hddtemp_write (char *host, char *inst, char *val)
-{
-       char filename[BUFFER_SIZE];
-       int status;
+static const char *config_keys[] = {"Host", "Port"};
+static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
 
-       /* construct filename */
-       status = snprintf (filename, BUFFER_SIZE, filename_format, inst);
-       if (status < 1)
-               return;
-       else if (status >= BUFFER_SIZE)
-               return;
+static char *hddtemp_host = NULL;
+static char hddtemp_port[16];
 
-       rrd_update_file (host, filename, val, ds_def, ds_num);
+/*
+ * 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 char *hddtemp_query_daemon(void) {
+  int fd;
+  ssize_t status;
+
+  char *buffer;
+  int buffer_size;
+  int buffer_fill;
+  char *new_buffer;
+
+  const char *host;
+  const char *port;
+
+  struct addrinfo *ai_list;
+  int ai_return;
+
+  host = hddtemp_host;
+  if (host == NULL)
+    host = HDDTEMP_DEF_HOST;
+
+  port = hddtemp_port;
+  if (strlen(port) == 0)
+    port = HDDTEMP_DEF_PORT;
+
+  struct addrinfo ai_hints = {.ai_flags = AI_ADDRCONFIG,
+                              .ai_family = AF_UNSPEC,
+                              .ai_protocol = IPPROTO_TCP,
+                              .ai_socktype = SOCK_STREAM};
+
+  if ((ai_return = getaddrinfo(host, port, &ai_hints, &ai_list)) != 0) {
+    char errbuf[1024];
+    ERROR("hddtemp plugin: getaddrinfo (%s, %s): %s", host, port,
+          (ai_return == EAI_SYSTEM) ? sstrerror(errno, errbuf, sizeof(errbuf))
+                                    : gai_strerror(ai_return));
+    return (NULL);
+  }
+
+  fd = -1;
+  for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
+       ai_ptr = ai_ptr->ai_next) {
+    /* create our socket descriptor */
+    fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
+    if (fd < 0) {
+      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)) {
+      char errbuf[1024];
+      INFO("hddtemp plugin: connect (%s, %s) failed: %s", host, port,
+           sstrerror(errno, errbuf, sizeof(errbuf)));
+      close(fd);
+      fd = -1;
+      continue;
+    }
+
+    /* A socket could be opened and connecting succeeded. We're
+     * done. */
+    break;
+  }
+
+  freeaddrinfo(ai_list);
+
+  if (fd < 0) {
+    ERROR("hddtemp plugin: Could not connect to daemon.");
+    return (NULL);
+  }
+
+  /* receive data from the hddtemp daemon */
+  buffer = NULL;
+  buffer_size = 0;
+  buffer_fill = 0;
+  while (1) {
+    if ((buffer_size == 0) || (buffer_fill >= buffer_size - 1)) {
+      if (buffer_size == 0)
+        buffer_size = 1024;
+      else
+        buffer_size *= 2;
+      if (buffer_size > HDDTEMP_MAX_RECV_BUF) {
+        WARNING("hddtemp plugin: Message from hddtemp has been "
+                "truncated.");
+        break;
+      }
+      new_buffer = realloc(buffer, buffer_size);
+      if (new_buffer == NULL) {
+        close(fd);
+        free(buffer);
+        ERROR("hddtemp plugin: Allocation failed.");
+        return (NULL);
+      }
+      buffer = new_buffer;
+    }
+    status = read(fd, buffer + buffer_fill, buffer_size - buffer_fill - 1);
+    if (status == 0) {
+      break;
+    } else if (status == -1) {
+      char errbuf[1024];
+
+      if ((errno == EAGAIN) || (errno == EINTR))
+        continue;
+
+      ERROR("hddtemp plugin: Error reading from socket: %s",
+            sstrerror(errno, errbuf, sizeof(errbuf)));
+      close(fd);
+      free(buffer);
+      return (NULL);
+    }
+    buffer_fill += status;
+  }
+
+  if (buffer_fill == 0) {
+    WARNING("hddtemp plugin: Peer has unexpectedly shut down "
+            "the socket. Buffer: `%s'",
+            buffer);
+    close(fd);
+    free(buffer);
+    return (NULL);
+  }
+
+  assert(buffer_fill < buffer_size);
+  buffer[buffer_fill] = '\0';
+  close(fd);
+  return (buffer);
 }
 
-static char *hddtemp_get_name (char *drive)
-{
-       hddname_t *list;
-       char *ret;
-
-       for (list = first_hddname; list != NULL; list = list->next)
-               if (strcmp (drive, list->name) == 0)
-                       break;
-
-       if (list == NULL)
-               return (strdup (drive));
-
-       if ((ret = (char *) malloc (128 * sizeof (char))) == NULL)
-               return (NULL);
-
-       if (snprintf (ret, 128, "%i-%i", list->major, list->minor) >= 128)
-       {
-               free (ret);
-               return (NULL);
-       }
-
-       return (ret);
+static int hddtemp_config(const char *key, const char *value) {
+  if (strcasecmp(key, "Host") == 0) {
+    if (hddtemp_host != NULL)
+      free(hddtemp_host);
+    hddtemp_host = strdup(value);
+  } else if (strcasecmp(key, "Port") == 0) {
+    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 {
+    return (-1);
+  }
+
+  return (0);
 }
 
-static void hddtemp_submit (char *inst, double temperature)
-{
-       char buf[BUFFER_SIZE];
+static void hddtemp_submit(char *type_instance, double value) {
+  value_list_t vl = VALUE_LIST_INIT;
 
-       if (snprintf (buf, BUFFER_SIZE, "%u:%.3f", (unsigned int) curtime, temperature) >= BUFFER_SIZE)
-               return;
+  vl.values = &(value_t){.gauge = value};
+  vl.values_len = 1;
+  sstrncpy(vl.plugin, "hddtemp", sizeof(vl.plugin));
+  sstrncpy(vl.type, "temperature", sizeof(vl.type));
+  sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 
-       plugin_submit (MODULE_NAME, inst, buf);
+  plugin_dispatch_values(&vl);
 }
 
-static void hddtemp_read (void)
-{
-       char buf[BUFFER_SIZE];
-       char *fields[128];
-       char *ptr;
-       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;
-       }
-
-       /* NB: strtok will eat up "||" and leading "|"'s */
-       num_fields = 0;
-       ptr = buf;
-       while ((fields[num_fields] = strtok (ptr, "|")) != NULL)
-       {
-               ptr = NULL;
-               num_fields++;
-
-               if (num_fields >= 128)
-                       break;
-       }
-
-       num_disks = num_fields / 4;
-
-       for (i = 0; i < num_disks; i++)
-       {
-               char *name, *submit_name;
-               double temperature;
-               char *mode;
-
-               mode = fields[4*i + 3];
-
-               /* 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 */
-               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);
-               }
-       }
-}
+static int hddtemp_read(void) {
+  char *buf;
+  char *ptr;
+  char *saveptr;
+  char *name;
+  char *model;
+  char *temperature;
+  char *mode;
+
+  /* get data from daemon */
+  buf = hddtemp_query_daemon();
+  if (buf == NULL)
+    return (-1);
+
+  /* NB: strtok_r will eat up "||" and leading "|"'s */
+  ptr = buf;
+  saveptr = NULL;
+  while ((name = strtok_r(ptr, "|", &saveptr)) != NULL &&
+         (model = strtok_r(NULL, "|", &saveptr)) != NULL &&
+         (temperature = strtok_r(NULL, "|", &saveptr)) != NULL &&
+         (mode = strtok_r(NULL, "|", &saveptr)) != NULL) {
+    double temperature_value;
+
+    ptr = NULL;
+
+    /* Skip non-temperature information */
+    if (mode[0] != 'C' && mode[0] != 'F')
+      continue;
+
+    name = basename(name);
+    temperature_value = atof(temperature);
+
+    /* Convert farenheit to celsius */
+    if (mode[0] == 'F')
+      temperature_value = (temperature_value - 32.0) * 5.0 / 9.0;
+
+    hddtemp_submit(name, temperature_value);
+  }
+
+  free(buf);
+  return (0);
+} /* int hddtemp_read */
 
 /* module_register
    Register collectd plugin. */
-void module_register (void)
-{
-       plugin_register (MODULE_NAME, hddtemp_init, hddtemp_read, hddtemp_write);
+void module_register(void) {
+  plugin_register_config("hddtemp", hddtemp_config, config_keys,
+                         config_keys_num);
+  plugin_register_read("hddtemp", hddtemp_read);
 }
-
-#endif /* COLLECT_HDDTEMP */