X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fapcups.c;h=1eddcd5e9c1bb3506a9f2ca3d9a433355229daa7;hb=4f27b7128f48771fb28de092cf56759bf6cb7f45;hp=b9a500d00f64769b08d66d77f8e467330daf84d8;hpb=d82759c8f5904fc793c42b6637b90ddaa194a65c;p=collectd.git

diff --git a/src/apcups.c b/src/apcups.c
index b9a500d0..1eddcd5e 100644
--- a/src/apcups.c
+++ b/src/apcups.c
@@ -34,7 +34,6 @@
 #include "plugin.h"      /* plugin_register, plugin_submit */
 #include "configfile.h"  /* cf_register */
 #include "utils_debug.h"
-#include <errno.h>
 
 #if HAVE_SYS_TYPES_H
 # include <sys/types.h>
@@ -50,177 +49,115 @@
 # include <netinet/in.h>
 #endif
 
-#ifndef APCMAIN
-# define APCMAIN 0
-#endif
-
 #define NISPORT 3551
 #define MAXSTRING               256
 #define MODULE_NAME "apcups"
 
+#define APCUPS_DEFAULT_HOST "localhost"
+
+/*
+ * Private data types
+ */
+struct apc_detail_s
+{
+	double linev;
+	double loadpct;
+	double bcharge;
+	double timeleft;
+	double outputv;
+	double itemp;
+	double battv;
+	double linefreq;
+};
+
+/*
+ * Private variables
+ */
 /* Default values for contacting daemon */
-static char *global_host = "localhost";
-static int   global_port = NISPORT;
+static char *conf_host = NULL;
+static int   conf_port = NISPORT;
+
+static int global_sockfd = -1;
 
 /* 
  * 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[] = 
+static data_source_t data_source_voltage[1] =
 {
-	"DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":0:U",
+	{"voltage", DS_TYPE_GAUGE, NAN, NAN}
 };
-static int bvolt_ds_num = 1;
 
-static char *load_file_template = "apcups/charge_percent.rrd";
-static char *load_ds_def[] = 
+static data_set_t ds_voltage =
 {
-	"DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
+	"voltage", 1, data_source_voltage
 };
-static int load_ds_num = 1;
 
-static char *charge_file_template = "apcups/charge.rrd";
-static char *charge_ds_def[] = 
+static data_source_t data_source_percent[1] =
 {
-	"DS:charge:GAUGE:"COLLECTD_HEARTBEAT":0:U",
+	{"percent", DS_TYPE_GAUGE, 0, 100.1}
 };
-static int charge_ds_num = 1;
 
-static char *time_file_template = "apcups/time.rrd";
-static char *time_ds_def[] = 
+static data_set_t ds_percent =
 {
-	"DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100",
+	"percent", 1, data_source_percent
 };
-static int time_ds_num = 1;
 
-static char *temp_file_template = "apcups/temperature.rrd";
-static char *temp_ds_def[] = 
+static data_source_t data_source_timeleft[1] =
 {
-	/* -273.15 is absolute zero */
-	"DS:temperature:GAUGE:"COLLECTD_HEARTBEAT":-274:U",
+	{"timeleft", DS_TYPE_GAUGE, 0, 100.0}
 };
-static int temp_ds_num = 1;
 
-static char *freq_file_template = "apcups/frequency-%s.rrd";
-static char *freq_ds_def[] = 
+static data_set_t ds_timeleft =
 {
-	"DS:frequency:GAUGE:"COLLECTD_HEARTBEAT":0:U",
+	"timeleft", 1, data_source_timeleft
 };
-static int freq_ds_num = 1;
 
-static char *config_keys[] =
+static data_source_t data_source_temperature[1] =
 {
-	"Host",
-	"Port",
-	NULL
+	{"value", DS_TYPE_GAUGE, -273.15, NAN}
 };
-static int config_keys_num = 2;
 
-#endif /* if APCMAIN */
-
-struct apc_detail_s
+static data_set_t ds_temperature =
 {
-	double linev;
-	double loadpct;
-	double bcharge;
-	double timeleft;
-	double outputv;
-	double itemp;
-	double battv;
-	double linefreq;
+	"temperature", 1, data_source_temperature
 };
 
-#define BIG_BUF 4096
-
-/*
- * 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 data_source_t data_source_frequency[1] =
 {
-	int nleft;
-	int nread;
-
-	nleft = nbytes;
-	nread = -1;
-
-	assert (*fd >= 0);
-
-	while ((nleft > 0) && (nread != 0))
-	{
-		nread = read (*fd, ptr, nleft);
-
-		if (nread == -1 && (errno == EINTR || errno == EAGAIN))
-			continue;
-
-		if (nread == -1)
-		{
-			*fd = -1;
-			syslog (LOG_ERR, "apcups plugin: write failed: %s", strerror (errno));
-			return (-1);
-		}
-
-		nleft -= nread;
-		ptr += nread;
-	}
-
-	return (nbytes - nleft);
-}
+	{"frequency", DS_TYPE_GAUGE, 0, NAN}
+};
 
-/*
- * Write nbytes to the network.
- * It may require several writes.
- */
-static int write_nbytes (int *fd, void *buf, int buflen)
+static data_set_t ds_frequency =
 {
-	int nleft;
-	int nwritten;
-	char *ptr;
-
-	assert (buflen > 0);
-	assert (*fd >= 0);
-
-	ptr = (char *) buf;
-
-	nleft = buflen;
-	while (nleft > 0)
-	{
-		nwritten = write (*fd, ptr, nleft);
-
-		if ((nwritten == -1) && ((errno == EAGAIN) || (errno == EINTR)))
-			continue;
-
-		if (nwritten == -1)
-		{
-			syslog (LOG_ERR, "Writing to socket failed: %s", strerror (errno));
-			*fd = -1;
-			return (-1);
-		}
-
-		nleft -= nwritten;
-		ptr += nwritten;
-	}
+	"frequency", 1, data_source_frequency
+};
 
-	/* If we get here, (nleft <= 0) is true */
-	return (buflen);
-}
+static const char *config_keys[] =
+{
+	"Host",
+	"Port",
+	NULL
+};
+static int config_keys_num = 2;
 
 /* Close the network connection */
-static void net_close (int *fd)
+static int apcups_shutdown (void)
 {
-	short pktsiz = 0;
+	uint16_t packet_size = 0;
 
-	assert (*fd >= 0);
+	if (global_sockfd < 0)
+		return (0);
+
+	DBG ("Gracefully shutting down socket %i.", global_sockfd);
 
 	/* send EOF sentinel */
-	write_nbytes (fd, &pktsiz, sizeof (short));
+	swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size));
 
-	close (*fd);
-	*fd = -1;
-}
+	close (global_sockfd);
+	global_sockfd = -1;
 
+	return (0);
+} /* int apcups_shutdown */
 
 /*     
  * Open a TCP connection to the UPS network server
@@ -278,9 +215,12 @@ static int net_open (char *host, char *service, int port)
 	if (status != 0) /* `connect(2)' failed */
 	{
 		DBG ("connect failed: %s", strerror (errno));
+		close (sd);
 		return (-1);
 	}
 
+	DBG ("Done opening a socket %i", sd);
+
 	return (sd);
 } /* int net_open (char *host, char *service, int port) */
 
@@ -295,35 +235,34 @@ static int net_open (char *host, char *service, int port)
  */
 static int net_recv (int *sockfd, char *buf, int buflen)
 {
-	int   nbytes;
-	short pktsiz;
+	uint16_t packet_size;
 
 	/* get data size -- in short */
-	if ((nbytes = read_nbytes (sockfd, (char *) &pktsiz, sizeof (short))) <= 0)
+	if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
+	{
+		*sockfd = -1;
 		return (-1);
+	}
 
-	if (nbytes != sizeof (short))
-		return (-2);
-
-	pktsiz = ntohs (pktsiz);
-	if (pktsiz > buflen)
+	packet_size = ntohs (packet_size);
+	if (packet_size > buflen)
 	{
 		DBG ("record length too large");
 		return (-2);
 	}
 
-	if (pktsiz == 0)
+	if (packet_size == 0)
 		return (0);
 
 	/* now read the actual data */
-	if ((nbytes = read_nbytes (sockfd, buf, pktsiz)) <= 0)
-		return (-2);
-
-	if (nbytes != pktsiz)
-		return (-2);
+	if (sread (*sockfd, (void *) buf, packet_size) != 0)
+	{
+		*sockfd = -1;
+		return (-1);
+	}
 
-	return (nbytes);
-} /* static int net_recv (int sockfd, char *buf, int buflen) */
+	return ((int) packet_size);
+} /* static int net_recv (int *sockfd, char *buf, int buflen) */
 
 /*
  * Send a message over the network. The send consists of
@@ -334,22 +273,26 @@ static int net_recv (int *sockfd, char *buf, int buflen)
  */
 static int net_send (int *sockfd, char *buff, int len)
 {
-	int rc;
-	short packet_size;
+	uint16_t packet_size;
 
 	assert (len > 0);
+	assert (*sockfd >= 0);
 
 	/* send short containing size of data packet */
-	packet_size = htons ((short) len);
+	packet_size = htons ((uint16_t) len);
 
-	rc = write_nbytes (sockfd, &packet_size, sizeof (packet_size));
-	if (rc != sizeof (packet_size))
+	if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
+	{
+		*sockfd = -1;
 		return (-1);
+	}
 
 	/* send data packet */
-	rc = write_nbytes (sockfd, buff, len);
-	if (rc != len)
-		return (-1);
+	if (swrite (*sockfd, (void *) buff, len) != 0)
+	{
+		*sockfd = -1;
+		return (-2);
+	}
 
 	return (0);
 }
@@ -364,8 +307,7 @@ static int apc_query_server (char *host, int port,
 	char   *key;
 	double  value;
 
-	static int sockfd   = -1;
-	static unsigned int complain = 0;
+	static complain_t compl;
 
 #if APCMAIN
 # define PRINT_VALUE(name, val) printf("  Found property: name = %s; value = %f;\n", name, val)
@@ -373,33 +315,28 @@ static int apc_query_server (char *host, int port,
 # define PRINT_VALUE(name, val) /**/
 #endif
 
-	if (sockfd < 0)
+	if (global_sockfd < 0)
 	{
-		if ((sockfd = net_open (host, NULL, port)) < 0)
+		if ((global_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++;
-
+			plugin_complain (LOG_ERR, &compl, "apcups plugin: "
+					"Connecting to the apcupsd failed.");
 			return (-1);
-		} else {
-			if(complain > 1)
-				syslog (LOG_ERR, "apcups plugin: Connection re-established to the apcupsd.");
 		}
-		complain = 0;
+		else
+		{
+			plugin_relief (LOG_NOTICE, &compl, "apcups plugin: "
+					"Connection re-established to the apcupsd.");
+		}
 	}
 
-	if (net_send (&sockfd, "status", 6) < 0)
+	if (net_send (&global_sockfd, "status", 6) < 0)
 	{
 		syslog (LOG_ERR, "apcups plugin: Writing to the socket failed.");
 		return (-1);
 	}
 
- 	/* XXX: Do we read `n' or `n-1' bytes? */
-	while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0)
+	while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
 	{
 		assert (n < sizeof (recvline));
 		recvline[n] = '\0';
@@ -407,30 +344,31 @@ static int apc_query_server (char *host, int port,
 		printf ("net_recv = `%s';\n", recvline);
 #endif /* if APCMAIN */
 
-		tokptr = strtok (recvline, ":");
+		tokptr = strtok (recvline, " :\t");
 		while (tokptr != NULL)
 		{
 			key = tokptr;
-			if ((tokptr = strtok (NULL, " \t")) == NULL)
+			if ((tokptr = strtok (NULL, " :\t")) == NULL)
 				continue;
 			value = atof (tokptr);
+
 			PRINT_VALUE (key, value);
 
 			if (strcmp ("LINEV", key) == 0)
 				apcups_detail->linev = value;
-			else if (strcmp ("BATTV", tokptr) == 0)
+			else if (strcmp ("BATTV", key) == 0) 
 				apcups_detail->battv = value;
-			else if (strcmp ("ITEMP", tokptr) == 0)
+			else if (strcmp ("ITEMP", key) == 0)
 				apcups_detail->itemp = value;
-			else if (strcmp ("LOADPCT", tokptr) == 0)
+			else if (strcmp ("LOADPCT", key) == 0)
 				apcups_detail->loadpct = value;
-			else if (strcmp ("BCHARGE", tokptr) == 0)
+			else if (strcmp ("BCHARGE", key) == 0)
 				apcups_detail->bcharge = value;
-			else if (strcmp ("OUTPUTV", tokptr) == 0)
+			else if (strcmp ("OUTPUTV", key) == 0)
 				apcups_detail->outputv = value;
-			else if (strcmp ("LINEFREQ", tokptr) == 0)
+			else if (strcmp ("LINEFREQ", key) == 0)
 				apcups_detail->linefreq = value;
-			else if (strcmp ("TIMELEFT", tokptr) == 0)
+			else if (strcmp ("TIMELEFT", key) == 0)
 				apcups_detail->timeleft = value;
 
 			tokptr = strtok (NULL, ":");
@@ -441,49 +379,21 @@ static int apc_query_server (char *host, int port,
 	{
 		syslog (LOG_WARNING, "apcups plugin: Error reading from socket");
 		return (-1);
-	} else {
-		/* close the opened socket */
-		net_close(&sockfd);
 	}
 
-
 	return (0);
 }
 
-#if APCMAIN
-/*
- * This is used for testing apcups in a standalone mode.
- * Usefull for debugging.
- */
-int main (int argc, char **argv)
-{
-	/* we are not really going to use this */
-	struct apc_detail_s apcups_detail;
-
-	openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1, LOG_USER);
-
-	if (global_host == NULL || strcmp (global_host, "0.0.0.0") == 0)
-		global_host = "localhost";
-
-	if(apc_query_server (global_host, global_port, &apcups_detail) < 0)
-	{
-		printf("apcups: Failed...\n");
-		return(-1);
-	}
-
-	return 0;
-}
-#else
-static int apcups_config (char *key, char *value)
+static int apcups_config (const char *key, const char *value)
 {
 	if (strcasecmp (key, "host") == 0)
 	{
-		if (global_host != NULL)
+		if (conf_host != NULL)
 		{
-			free (global_host);
-			global_host = NULL;
+			free (conf_host);
+			conf_host = NULL;
 		}
-		if ((global_host = strdup (value)) == NULL)
+		if ((conf_host = strdup (value)) == NULL)
 			return (1);
 	}
 	else if (strcasecmp (key, "Port") == 0)
@@ -494,7 +404,7 @@ static int apcups_config (char *key, char *value)
 			syslog (LOG_WARNING, "apcups plugin: Invalid port: %i", port_tmp);
 			return (1);
 		}
-		global_port = port_tmp;
+		conf_port = port_tmp;
 	}
 	else
 	{
@@ -503,67 +413,22 @@ static int apcups_config (char *key, char *value)
 	return (0);
 }
 
-static void apcups_init (void)
-{
-	return;
-}
-
-static void apc_write_voltage (char *host, char *inst, char *val)
-{
-	char file[512];
-	int  status;
-
-	status = snprintf (file, 512, bvolt_file_template, inst);
-	if ((status < 1) || (status >= 512))
-		return;
-
-	rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num);
-}
-
-static void apc_write_charge (char *host, char *inst, char *val)
-{
-	rrd_update_file (host, charge_file_template, val, charge_ds_def, charge_ds_num);
-}
-
-static void apc_write_percent (char *host, char *inst, char *val)
-{
-	rrd_update_file (host, load_file_template, val, load_ds_def, load_ds_num);
-}
-
-static void apc_write_timeleft (char *host, char *inst, char *val)
-{
-	rrd_update_file (host, time_file_template, val, time_ds_def, time_ds_num);
-}
-
-static void apc_write_temperature (char *host, char *inst, char *val)
+static void apc_submit_generic (char *type, char *type_inst, double value)
 {
-	rrd_update_file (host, temp_file_template, val, temp_ds_def, temp_ds_num);
-}
+	value_t values[1];
+	value_list_t vl = VALUE_LIST_INIT;
 
-static void apc_write_frequency (char *host, char *inst, char *val)
-{
-	char file[512];
-	int  status;
+	values[0].gauge = value;
 
-	status = snprintf (file, 512, freq_file_template, inst);
-	if ((status < 1) || (status >= 512))
-		return;
+	vl.values = values;
+	vl.values_len = 1;
+	vl.time = time (NULL);
+	strcpy (vl.host, hostname);
+	strcpy (vl.plugin, "apcups");
+	strcpy (vl.plugin_instance, "");
+	strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 
-	rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
-}
-
-static void apc_submit_generic (char *type, char *inst,
-		double value)
-{
-	char buf[512];
-	int  status;
-
-	status = snprintf (buf, 512, "%u:%f",
-			(unsigned int) curtime, value);
-	if ((status < 1) || (status >= 512))
-		return;
-
-	plugin_submit (type, inst, buf);
+	plugin_dispatch_values (type, &vl);
 }
 
 static void apc_submit (struct apc_detail_s *apcups_detail)
@@ -571,21 +436,18 @@ static void apc_submit (struct apc_detail_s *apcups_detail)
 	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);
-	apc_submit_generic ("apcups_charge",     "-",       apcups_detail->bcharge);
-	apc_submit_generic ("apcups_charge_pct", "-",       apcups_detail->loadpct);
-	apc_submit_generic ("apcups_timeleft",   "-",       apcups_detail->timeleft);
-	apc_submit_generic ("apcups_temp",       "-",       apcups_detail->itemp);
+	apc_submit_generic ("apcups_charge",     "",        apcups_detail->bcharge);
+	apc_submit_generic ("apcups_charge_pct", "",        apcups_detail->loadpct);
+	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);
 }
 
-static void apcups_read (void)
+static int apcups_read (void)
 {
 	struct apc_detail_s apcups_detail;
 	int status;
 
-	if (global_host == NULL)
-		return;
-	
 	apcups_detail.linev    =   -1.0;
 	apcups_detail.outputv  =   -1.0;
 	apcups_detail.battv    =   -1.0;
@@ -595,29 +457,40 @@ static void apcups_read (void)
 	apcups_detail.itemp    = -300.0;
 	apcups_detail.linefreq =   -1.0;
   
-	status = apc_query_server (global_host, global_port, &apcups_detail);
+	status = apc_query_server (conf_host == NULL
+			? APCUPS_DEFAULT_HOST
+			: conf_host,
+			conf_port, &apcups_detail);
  
 	/*
 	 * if we did not connect then do not bother submitting
 	 * zeros. We want rrd files to have NAN.
 	 */
 	if (status != 0)
-		return;
+	{
+		DBG ("apc_query_server (%s, %i) = %i",
+				conf_host == NULL
+				? APCUPS_DEFAULT_HOST
+				: conf_host,
+				conf_port, status);
+		return (-1);
+	}
 
 	apc_submit (&apcups_detail);
+
+	return (0);
 } /* apcups_read */
 
 void module_register (void)
 {
-	plugin_register (MODULE_NAME, apcups_init, apcups_read, NULL);
-	plugin_register ("apcups_voltage",    NULL, NULL, apc_write_voltage);
-	plugin_register ("apcups_charge",     NULL, NULL, apc_write_charge);
-	plugin_register ("apcups_charge_pct", NULL, NULL, apc_write_percent);
-	plugin_register ("apcups_timeleft",   NULL, NULL, apc_write_timeleft);
-	plugin_register ("apcups_temp",       NULL, NULL, apc_write_temperature);
-	plugin_register ("apcups_frequency",  NULL, NULL, apc_write_frequency);
-	cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num);
-}
+	plugin_register_data_set (&ds_voltage);
+	plugin_register_data_set (&ds_percent);
+	plugin_register_data_set (&ds_timeleft);
+	plugin_register_data_set (&ds_temperature);
+	plugin_register_data_set (&ds_frequency);
 
-#endif /* if APCMAIN */
-#undef MODULE_NAME
+	plugin_register_config ("apcups", apcups_config, config_keys, config_keys_num);
+
+	plugin_register_read ("apcups", apcups_read);
+	plugin_register_shutdown ("apcups", apcups_shutdown);
+}