Code

1. Keeping the socket open on my system, when apcupsd is shutdown, collectd dies...
[collectd.git] / src / apcups.c
index f3353482b7ad01305c2d8314838c8d10b48aa837..b9a500d00f64769b08d66d77f8e467330daf84d8 100644 (file)
 #include "plugin.h"      /* plugin_register, plugin_submit */
 #include "configfile.h"  /* cf_register */
 #include "utils_debug.h"
-
-<<<<<<< .mine
-#include <string.h>
 #include <errno.h>
-#include <netdb.h>
-#include <sys/socket.h>                        /* Used for socket connections */
-#include <netinet/in.h>                        /* Used for socket connections */
-#include <arpa/inet.h>                 /* Used for socket connections */
-=======
+
 #if HAVE_SYS_TYPES_H
 # include <sys/types.h>
 #endif
 #if HAVE_NETDB_H
 # include <netdb.h>
 #endif
+
 #if HAVE_NETINET_IN_H
 # include <netinet/in.h>
 #endif
 
-#if 0
-#if HAVE_ARPA_INET_H
-# include <arpa/inet.h> /* inet_addr */
-#endif
-#include <pwd.h>
-#include <setjmp.h> /* FIXME: Is this really neccessary? */
-#include <termios.h> /* FIXME: Is this really neccessary? */
-#include <sys/ioctl.h> /* FIXME: Is this really neccessary? */
-#include <sys/ipc.h> /* FIXME: Is this really neccessary? */
-#include <sys/sem.h> /* FIXME: Is this really neccessary? */
-#include <sys/shm.h> /* FIXME: Is this really neccessary? */
+#ifndef APCMAIN
+# define APCMAIN 0
 #endif
->>>>>>> .r743
-
-
 
 #define NISPORT 3551
-#define _(String) (String)
-#define N_(String) (String)
 #define MAXSTRING               256
 #define MODULE_NAME "apcups"
 
-<<<<<<< .mine
-
-=======
->>>>>>> .r743
 /* Default values for contacting daemon */
-<<<<<<< .mine
-static char *host = "localhost";       /* the default host to connect to */
-static int port = NISPORT;             /* the default port to connect to */
-=======
-static char *global_host = NULL;
+static char *global_host = "localhost";
 static int   global_port = NISPORT;
->>>>>>> .r743
-
-<<<<<<< .mine
-/*
- * This is used in do_apc_status() to track the last connection state.
- * We do not want the read function spitting out an error every "step"
- * seconds (usually 10 secs).
- */
-static int apcConnStatus = 0;
 
-static struct sockaddr_in tcp_serv_addr;  /* socket information */
-static char *net_errmsg = NULL;           /* pointer to error message */
-static char net_errbuf[256];              /* error message buffer for messages */
-
-=======
->>>>>>> .r743
-/* 
- * The following are normally compiled, when the module is compiled with its
- * own main for testing these are ifdef'd out.
- */
 /* 
- * FIXME: Rename DSes to be more generic and follow established conventions.
- *  However, they currently match the values put out by apcupsd.
- */
-#ifndef APCMAIN
+ * The following are only if not compiled to test the module with its own main.
+*/
+#if !APCMAIN
 static char *bvolt_file_template = "apcups/voltage-%s.rrd";
 static char *bvolt_ds_def[] = 
 {
@@ -124,7 +76,7 @@ static int bvolt_ds_num = 1;
 static char *load_file_template = "apcups/charge_percent.rrd";
 static char *load_ds_def[] = 
 {
-       "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:100",
+       "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
 };
 static int load_ds_num = 1;
 
@@ -165,21 +117,10 @@ static char *config_keys[] =
 };
 static int config_keys_num = 2;
 
-#endif /* ifndef APCMAIN */
+#endif /* if APCMAIN */
 
 struct apc_detail_s
 {
-<<<<<<< .mine
-        int connected;
-       float linev;
-       float loadpct;
-       float bcharge;
-       float timeleft;
-       float outputv;
-       float itemp;
-       float battv;
-       float linefreq;
-=======
        double linev;
        double loadpct;
        double bcharge;
@@ -188,67 +129,74 @@ struct apc_detail_s
        double itemp;
        double battv;
        double linefreq;
->>>>>>> .r743
 };
 
-<<<<<<< .mine
-=======
 #define BIG_BUF 4096
 
->>>>>>> .r743
 /*
  * Read nbytes from the network.
  * It is possible that the total bytes require in several
  * read requests
  */
-static int read_nbytes (int fd, char *ptr, int nbytes)
+static int read_nbytes (int *fd, char *ptr, int nbytes)
 {
-       int nleft, nread;
+       int nleft;
+       int nread;
 
        nleft = nbytes;
+       nread = -1;
+
+       assert (*fd >= 0);
+
+       while ((nleft > 0) && (nread != 0))
+       {
+               nread = read (*fd, ptr, nleft);
 
-       while (nleft > 0) {
-               do {
-                       nread = read (fd, ptr, nleft);
-               } while (nread == -1 && (errno == EINTR || errno == EAGAIN));
+               if (nread == -1 && (errno == EINTR || errno == EAGAIN))
+                       continue;
 
-               if (nread <= 0) {
-                       return (nread);           /* error, or EOF */
+               if (nread == -1)
+               {
+                       *fd = -1;
+                       syslog (LOG_ERR, "apcups plugin: write failed: %s", strerror (errno));
+                       return (-1);
                }
 
                nleft -= nread;
                ptr += nread;
        }
 
-       return (nbytes - nleft);        /* return >= 0 */
+       return (nbytes - nleft);
 }
 
 /*
  * Write nbytes to the network.
  * It may require several writes.
  */
-static int write_nbytes (int fd, void *buf, int buflen)
+static int write_nbytes (int *fd, void *buf, int buflen)
 {
        int nleft;
        int nwritten;
        char *ptr;
 
+       assert (buflen > 0);
+       assert (*fd >= 0);
+
        ptr = (char *) buf;
 
-<<<<<<< .mine
-               if (nwritten <= 0) {
-                       return (nwritten);        /* error */
-=======
        nleft = buflen;
        while (nleft > 0)
        {
-               nwritten = write (fd, ptr, nleft);
+               nwritten = write (*fd, ptr, nleft);
 
-               if (nwritten <= 0)
+               if ((nwritten == -1) && ((errno == EAGAIN) || (errno == EINTR)))
+                       continue;
+
+               if (nwritten == -1)
                {
                        syslog (LOG_ERR, "Writing to socket failed: %s", strerror (errno));
-                       return (nwritten);
->>>>>>> .r743
+                       *fd = -1;
+                       return (-1);
                }
 
                nleft -= nwritten;
@@ -260,13 +208,17 @@ static int write_nbytes (int fd, void *buf, int buflen)
 }
 
 /* Close the network connection */
-static void net_close (int sockfd)
+static void net_close (int *fd)
 {
        short pktsiz = 0;
 
+       assert (*fd >= 0);
+
        /* send EOF sentinel */
-       write_nbytes (sockfd, &pktsiz, sizeof (short));
-       close (sockfd);
+       write_nbytes (fd, &pktsiz, sizeof (short));
+
+       close (*fd);
+       *fd = -1;
 }
 
 
@@ -341,7 +293,7 @@ static int net_open (char *host, char *service, int port)
  * Returns -1 on hard end of file (i.e. network connection close)
  * Returns -2 on error
  */
-static int net_recv (int sockfd, char *buf, int buflen)
+static int net_recv (int *sockfd, char *buf, int buflen)
 {
        int   nbytes;
        short pktsiz;
@@ -380,11 +332,13 @@ static int net_recv (int sockfd, char *buf, int buflen)
  * Returns zero on success
  * Returns non-zero on error
  */
-static int net_send (int sockfd, char *buff, int len)
+static int net_send (int *sockfd, char *buff, int len)
 {
        int rc;
        short packet_size;
 
+       assert (len > 0);
+
        /* send short containing size of data packet */
        packet_size = htons ((short) len);
 
@@ -400,68 +354,57 @@ static int net_send (int sockfd, char *buff, int len)
        return (0);
 }
 
-<<<<<<< .mine
-/* 
- * Get and print status from apcupsd NIS server if APCMAIN is defined. 
- * Poplate apcups_detail structure for plugin submit().
- */
-static int do_apc_status(char *host, int port, struct apc_detail_s *apcups_detail)
-=======
 /* Get and print status from apcupsd NIS server */
 static int apc_query_server (char *host, int port,
                struct apc_detail_s *apcups_detail)
->>>>>>> .r743
 {
-       int     sockfd;
        int     n;
-       char    recvline[MAXSTRING + 1];
+       char    recvline[1024];
        char   *tokptr;
        char   *key;
-       float  value;
+       double  value;
+
+       static int sockfd   = -1;
+       static unsigned int complain = 0;
+
 #if APCMAIN
 # define PRINT_VALUE(name, val) printf("  Found property: name = %s; value = %f;\n", name, val)
 #else
 # define PRINT_VALUE(name, val) /**/
 #endif
 
-<<<<<<< .mine
-       /* 
-        * TODO: Keep the socket open, if possible.
-        * Can open socket in module init, but without a corresponding module
-        * uninit there is no place to gracefully close the socket.
-        */
-=======
-       /* TODO: Keep the socket open, if possible */
->>>>>>> .r743
-       if ((sockfd = net_open (host, NULL, port)) < 0)
+       if (sockfd < 0)
        {
-               /* 
-                * When the integer apcConnStatus rolls over it will print out
-                * again, if we haven't connected by then.
-                */
-               if (apcConnStatus++ == 0)
-                       syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed: %s",
-                               net_errmsg);
-               return (-1);
-       } else apcConnStatus = 0;
+               if ((sockfd = net_open (host, NULL, port)) < 0)
+               {
+                       /* Complain first time and once every six hours. */
+                       int complain_step = 21600 / atoi (COLLECTD_STEP);
+
+                       if (complain == 0 || (complain % complain_step) == 0)
+                               syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed.");
+                       complain++;
 
-       if (net_send (sockfd, "status", 6) < 0)
+                       return (-1);
+               } else {
+                       if(complain > 1)
+                               syslog (LOG_ERR, "apcups plugin: Connection re-established to the apcupsd.");
+               }
+               complain = 0;
+       }
+
+       if (net_send (&sockfd, "status", 6) < 0)
        {
-               syslog (LOG_ERR, "apcups plugin: sending to the apcupsd failed: %s",
-                       net_errmsg);
+               syslog (LOG_ERR, "apcups plugin: Writing to the socket failed.");
                return (-1);
        }
 
-<<<<<<< .mine
-=======
-       net_send (sockfd, "status", 6);
-
->>>>>>> .r743
-       while ((n = net_recv (sockfd, recvline, sizeof (recvline))) > 0)
+       /* XXX: Do we read `n' or `n-1' bytes? */
+       while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0)
        {
-               recvline[n-1] = '\0';
+               assert (n < sizeof (recvline));
+               recvline[n] = '\0';
 #if APCMAIN
-               printf ("net_recv = \"%s\"\n", recvline);
+               printf ("net_recv = `%s';\n", recvline);
 #endif /* if APCMAIN */
 
                tokptr = strtok (recvline, ":");
@@ -469,141 +412,70 @@ static int apc_query_server (char *host, int port,
                {
                        key = tokptr;
                        if ((tokptr = strtok (NULL, " \t")) == NULL)
-                               continue; 
+                               continue;
+                       value = atof (tokptr);
+                       PRINT_VALUE (key, value);
 
-                       if (strncmp ("LINEV", key,5) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       if (strcmp ("LINEV", key) == 0)
                                apcups_detail->linev = value;
-                       } else if (strncmp ("BATTV", key,5) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("BATTV", tokptr) == 0)
                                apcups_detail->battv = value;
-                       } else if (strncmp ("ITEMP", key,5) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("ITEMP", tokptr) == 0)
                                apcups_detail->itemp = value;
-                       } else if (strncmp ("LOADPCT", key,7) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("LOADPCT", tokptr) == 0)
                                apcups_detail->loadpct = value;
-                       } else if (strncmp ("BCHARGE", key,7) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("BCHARGE", tokptr) == 0)
                                apcups_detail->bcharge = value;
-                       } else if (strncmp ("OUTPUTV", key,7) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("OUTPUTV", tokptr) == 0)
                                apcups_detail->outputv = value;
-                       } else if (strncmp ("LINEFREQ", key,8) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("LINEFREQ", tokptr) == 0)
                                apcups_detail->linefreq = value;
-                       } else if (strncmp ("TIMELEFT", key,8) == 0) {
-                               value = atof (tokptr);
-                               PRINT_VALUE (key, value);
+                       else if (strcmp ("TIMELEFT", tokptr) == 0)
                                apcups_detail->timeleft = value;
-                       } 
 
                        tokptr = strtok (NULL, ":");
                } /* while (tokptr != NULL) */
        }
-
-<<<<<<< .mine
-       if (n < 0) {
-         syslog(LOG_ERR, "apcups plugin: Error recieving data: %s",
-                net_errmsg);
-         net_errmsg = NULL;
-         return(-1);
-       }
-=======
-       net_close (sockfd);
-
+       
        if (n < 0)
        {
                syslog (LOG_WARNING, "apcups plugin: Error reading from socket");
                return (-1);
+       } else {
+               /* close the opened socket */
+               net_close(&sockfd);
        }
->>>>>>> .r743
-
-<<<<<<< .mine
-       /* signal that we did in fact connect. */
-       apcups_detail->connected = 1;
 
-       net_close(sockfd);
 
-=======
->>>>>>> .r743
        return (0);
 }
 
-#ifdef APCMAIN
-<<<<<<< .mine
+#if APCMAIN
 /*
  * This is used for testing apcups in a standalone mode.
  * Usefull for debugging.
  */
-int main(int argc, char **argv)
-=======
 int main (int argc, char **argv)
->>>>>>> .r743
 {
        /* we are not really going to use this */
        struct apc_detail_s apcups_detail;
 
-<<<<<<< .mine
-       openlog("apcups",LOG_PID | LOG_NDELAY | LOG_LOCAL1);
+       openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1, LOG_USER);
 
-       if (!*host || strcmp(host, "0.0.0.0") == 0)
-=======
-       if (!*host || strcmp (host, "0.0.0.0") == 0)
->>>>>>> .r743
-               host = "localhost";
+       if (global_host == NULL || strcmp (global_host, "0.0.0.0") == 0)
+               global_host = "localhost";
 
-<<<<<<< .mine
-       if(do_apc_status(host, port, &apcups_detail) < 0) {
+       if(apc_query_server (global_host, global_port, &apcups_detail) < 0)
+       {
                printf("apcups: Failed...\n");
                return(-1);
        }
-=======
-       apc_query_server (global_host, global_port, &apcups_detail);
->>>>>>> .r743
 
        return 0;
 }
 #else
 static int apcups_config (char *key, char *value)
 {
-<<<<<<< .mine
-  static char lhost[126];
-  
-  if (strcasecmp (key, "host") == 0)
-    {
-      lhost[0] = '\0';
-      strcpy(lhost,key);
-      host = lhost;
-    }
-  else if (strcasecmp (key, "Port") == 0)
-    {
-      int port_tmp = atoi (value);
-      if(port_tmp < 1 || port_tmp > 65535) {
-       syslog (LOG_WARNING, "apcups: `port' failed: %s",
-               value);
-       return (1);
-      } else {
-       port = port_tmp;
-      }
-    }
-  else
-    {
-      return (-1);
-    }
-
-  if (strcmp(host, "0.0.0.0") == 0)
-       host = "localhost";
-
-  return(0);
-=======
        if (strcasecmp (key, "host") == 0)
        {
                if (global_host != NULL)
@@ -629,7 +501,6 @@ static int apcups_config (char *key, char *value)
                return (-1);
        }
        return (0);
->>>>>>> .r743
 }
 
 static void apcups_init (void)
@@ -671,127 +542,32 @@ static void apc_write_temperature (char *host, char *inst, char *val)
 
 static void apc_write_frequency (char *host, char *inst, char *val)
 {
-<<<<<<< .mine
-       struct apc_detail_s apcups_detail;
-       
-       apcups_detail.linev     = 0.0;
-       apcups_detail.loadpct   = 0.0;
-       apcups_detail.bcharge   = 0.0;
-       apcups_detail.timeleft  = 0.0;
-       apcups_detail.outputv   = 0.0;
-       apcups_detail.itemp     = 0.0;
-       apcups_detail.battv     = 0.0;
-       apcups_detail.linefreq  = 0.0;
-       apcups_detail.connected = 0;
-=======
        char file[512];
        int  status;
->>>>>>> .r743
 
-<<<<<<< .mine
-  
-       if (!*host || strcmp(host, "0.0.0.0") == 0)
-               host = "localhost";
-  
-       if(do_apc_status(host, port, &apcups_detail) < 0) return;
-       /*
-        * if we did not connect then do not bother submitting
-        * zeros. We want rrd files to have NAN.
-        */
-       if(!apcups_detail.connected) return;
-=======
        status = snprintf (file, 512, freq_file_template, inst);
        if ((status < 1) || (status >= 512))
                return;
->>>>>>> .r743
-
-<<<<<<< .mine
-       apcups_submit     (host, &apcups_detail);
-       apc_bvolt_submit  (host, &apcups_detail);
-       apc_load_submit   (host, &apcups_detail);
-       apc_charge_submit (host, &apcups_detail);
-       apc_temp_submit   (host, &apcups_detail);
-       apc_time_submit   (host, &apcups_detail);
-       apc_freq_submit   (host, &apcups_detail);
-=======
+
        rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
->>>>>>> .r743
 }
 
 static void apc_submit_generic (char *type, char *inst,
                double value)
 {
-<<<<<<< .mine
-       char file[512];
-       int status;
-
-       status = snprintf (file, 512, volt_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-
-       rrd_update_file (host, file, val, volt_ds_def, volt_ds_num);
-}
-=======
        char buf[512];
        int  status;
->>>>>>> .r743
-
-<<<<<<< .mine
-static void apc_bvolt_write (char *host, char *inst, char *val)
-{
-       char file[512];
-       int status;
-
-       status = snprintf (file, 512, bvolt_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-       return;
 
-       rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num);
-}
-=======
        status = snprintf (buf, 512, "%u:%f",
                        (unsigned int) curtime, value);
        if ((status < 1) || (status >= 512))
                return;
->>>>>>> .r743
 
-<<<<<<< .mine
-static void apc_load_write (char *host, char *inst, char *val)
-{
-       char file[512];
-       int status;
-  
-       status = snprintf (file, 512, load_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-       
-       rrd_update_file (host, file, val, load_ds_def, load_ds_num);
-=======
        plugin_submit (type, inst, buf);
->>>>>>> .r743
 }
 
 static void apc_submit (struct apc_detail_s *apcups_detail)
 {
-<<<<<<< .mine
-       char file[512];
-       int status;
-  
-       status = snprintf (file, 512, charge_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-  
-       rrd_update_file (host, file, val, charge_ds_def, charge_ds_num);
-=======
        apc_submit_generic ("apcups_voltage",    "input",   apcups_detail->linev);
        apc_submit_generic ("apcups_voltage",    "output",  apcups_detail->outputv);
        apc_submit_generic ("apcups_voltage",    "battery", apcups_detail->battv);
@@ -800,34 +576,13 @@ static void apc_submit (struct apc_detail_s *apcups_detail)
        apc_submit_generic ("apcups_timeleft",   "-",       apcups_detail->timeleft);
        apc_submit_generic ("apcups_temp",       "-",       apcups_detail->itemp);
        apc_submit_generic ("apcups_frequency",  "input",   apcups_detail->linefreq);
->>>>>>> .r743
 }
 
 static void apcups_read (void)
 {
-<<<<<<< .mine
-       char file[512];
-       int status;
-  
-       status = snprintf (file, 512, temp_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-  
-       rrd_update_file (host, file, val, temp_ds_def, temp_ds_num);
-}
-=======
        struct apc_detail_s apcups_detail;
        int status;
->>>>>>> .r743
 
-<<<<<<< .mine
-static void apc_time_write (char *host, char *inst, char *val)
-{
-       char file[512];
-       int status;
-=======
        if (global_host == NULL)
                return;
        
@@ -839,18 +594,7 @@ static void apc_time_write (char *host, char *inst, char *val)
        apcups_detail.timeleft =   -1.0;
        apcups_detail.itemp    = -300.0;
        apcups_detail.linefreq =   -1.0;
->>>>>>> .r743
   
-<<<<<<< .mine
-       status = snprintf (file, 512, time_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-  
-       rrd_update_file (host, file, val, time_ds_def, time_ds_num);
-}
-=======
        status = apc_query_server (global_host, global_port, &apcups_detail);
  
        /*
@@ -859,26 +603,9 @@ static void apc_time_write (char *host, char *inst, char *val)
         */
        if (status != 0)
                return;
->>>>>>> .r743
 
-<<<<<<< .mine
-static void apc_freq_write (char *host, char *inst, char *val)
-{
-       char file[512];
-       int status;
-  
-       status = snprintf (file, 512, freq_file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
-  
-       rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
-}
-=======
        apc_submit (&apcups_detail);
 } /* apcups_read */
->>>>>>> .r743
 
 void module_register (void)
 {
@@ -892,7 +619,5 @@ void module_register (void)
        cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num);
 }
 
-#endif /* ifdef APCMAIN */
+#endif /* if APCMAIN */
 #undef MODULE_NAME
-#undef MAXSTRING
-#undef NISPORT