X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fapcups.c;h=62c7a3c404844dcc1b8f9d66d2bdf72c7b75c32d;hb=e4b274ed754af52196d3390b8ce101a7f94e318a;hp=dfac373ce66e2b594bc68174ab9875dc6233bcf9;hpb=3953d68def8b939f0d8263ce8c9b3e5430f989d9;p=collectd.git diff --git a/src/apcups.c b/src/apcups.c index dfac373c..62c7a3c4 100644 --- a/src/apcups.c +++ b/src/apcups.c @@ -1,9 +1,11 @@ /* * collectd - src/apcups.c + * Copyright (C) 2007 Florian octo Forster * Copyright (C) 2006 Anthony Gialluca * Copyright (C) 2000-2004 Kern Sibbald * Copyright (C) 1996-99 Andre M. Hedrick * + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General * Public License as published by the Free Software Foundation. @@ -22,11 +24,17 @@ * Anthony Gialluca **/ +/* + * FIXME: Don't know why but without this here atof() was not returning + * correct values for me. This is behavior that I don't understand and + * should be examined in closer detail. + */ +#include + #include "collectd.h" -#include "common.h" /* rrd_update_file */ -#include "plugin.h" /* plugin_register, plugin_submit */ -#include "configfile.h" /* cf_register */ -#include "utils_debug.h" +#include "common.h" /* rrd_update_file */ +#include "plugin.h" /* plugin_register, plugin_submit */ +#include "configfile.h" /* cf_register */ #if HAVE_SYS_TYPES_H # include @@ -37,90 +45,42 @@ #if HAVE_NETDB_H # include #endif + #if HAVE_NETINET_IN_H # include #endif -#if HAVE_ARPA_INET_H -# include /* inet_addr */ -#endif - -#if 0 -#include -#include /* FIXME: Is this really neccessary? */ -#include /* FIXME: Is this really neccessary? */ -#include /* FIXME: Is this really neccessary? */ -#include /* FIXME: Is this really neccessary? */ -#include /* FIXME: Is this really neccessary? */ -#include /* FIXME: Is this really neccessary? */ -#endif #define NISPORT 3551 -#define _(String) (String) -#define N_(String) (String) #define MAXSTRING 256 #define MODULE_NAME "apcups" -/* Default values for contacting daemon */ -static char *host = "localhost"; -static int port = NISPORT; +#define APCUPS_DEFAULT_HOST "localhost" -/* - * The following are only if not compiled to test the module with its own main. -*/ -/* FIXME: Rename DSes to be more generic and follow established conventions. */ -#ifndef APCMAIN -static char *volt_file_template = "apcups_volt-%s.rrd"; -static char *volt_ds_def[] = -{ - "DS:linev:GAUGE:"COLLECTD_HEARTBEAT":0:250", - "DS:outputv:GAUGE:"COLLECTD_HEARTBEAT":0:250", - NULL -}; -static int volt_ds_num = 2; - -static char *bvolt_file_template = "apcups_bvolt-%s.rrd"; -static char *bvolt_ds_def[] = -{ - "DS:battv:GAUGE:"COLLECTD_HEARTBEAT":0:100", -}; -static int bvolt_ds_num = 1; - -static char *load_file_template = "apcups_load-%s.rrd"; -static char *load_ds_def[] = -{ - "DS:loadpct:GAUGE:"COLLECTD_HEARTBEAT":0:120", -}; -static int load_ds_num = 1; - -static char *charge_file_template = "apcups_charge-%s.rrd"; -static char *charge_ds_def[] = -{ - "DS:bcharge:GAUGE:"COLLECTD_HEARTBEAT":0:100", -}; -static int charge_ds_num = 1; - -static char *time_file_template = "apcups_time-%s.rrd"; -static char *time_ds_def[] = +/* + * Private data types + */ +struct apc_detail_s { - "DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100", + double linev; + double loadpct; + double bcharge; + double timeleft; + double outputv; + double itemp; + double battv; + double linefreq; }; -static int time_ds_num = 1; -static char *temp_file_template = "apcups_temp-%s.rrd"; -static char *temp_ds_def[] = -{ - "DS:itemp:GAUGE:"COLLECTD_HEARTBEAT":0:100", -}; -static int temp_ds_num = 1; +/* + * Private variables + */ +/* Default values for contacting daemon */ +static char *conf_host = NULL; +static int conf_port = NISPORT; -static char *freq_file_template = "apcups_freq-%s.rrd"; -static char *freq_ds_def[] = -{ - "DS:linefreq:GAUGE:"COLLECTD_HEARTBEAT":0:65", -}; -static int freq_ds_num = 1; +static int global_sockfd = -1; -static char *config_keys[] = +static const char *config_keys[] = { "Host", "Port", @@ -128,90 +88,24 @@ static char *config_keys[] = }; static int config_keys_num = 2; -#endif /* ifndef APCMAIN */ - -struct apc_detail_s -{ - float linev; - float loadpct; - float bcharge; - float timeleft; - float outputv; - float itemp; - float battv; - float linefreq; -}; - -#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) -{ - int nleft, nread; - - nleft = nbytes; - - while (nleft > 0) { - do { - nread = read(fd, ptr, nleft); - } while (nread == -1 && (errno == EINTR || errno == EAGAIN)); - - if (nread <= 0) { - return (nread); /* error, or EOF */ - } - - nleft -= nread; - ptr += nread; - } - - return (nbytes - nleft); /* return >= 0 */ -} - -/* - * Write nbytes to the network. - * It may require several writes. - */ -static int write_nbytes(int fd, void *buf, int buflen) +/* Close the network connection */ +static int apcups_shutdown (void) { - int nleft; - int nwritten; - char *ptr; - - ptr = (char *) buf; - - nleft = buflen; - while (nleft > 0) - { - nwritten = write(fd, ptr, nleft); - - if (nwritten <= 0) - { - syslog (LOG_ERR, "Writing to socket failed: %s", strerror (errno)); - return (nwritten); - } - - nleft -= nwritten; - ptr += nwritten; - } + uint16_t packet_size = 0; - /* If we get here, (nleft <= 0) is true */ - return (buflen); -} + if (global_sockfd < 0) + return (0); -/* Close the network connection */ -static void net_close (int sockfd) -{ - short pktsiz = 0; + DEBUG ("Gracefully shutting down socket %i.", global_sockfd); /* send EOF sentinel */ - write_nbytes (sockfd, &pktsiz, sizeof (short)); - close (sockfd); -} + swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size)); + + close (global_sockfd); + global_sockfd = -1; + return (0); +} /* int apcups_shutdown */ /* * Open a TCP connection to the UPS network server @@ -241,7 +135,11 @@ static int net_open (char *host, char *service, int port) status = getaddrinfo (host, port_str, &ai_hints, &ai_return); if (status != 0) { - DBG ("getaddrinfo failed: %s", status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status)); + char errbuf[1024]; + DEBUG ("getaddrinfo failed: %s", + (status == EAI_SYSTEM) + ? sstrerror (errno, errbuf, sizeof (errbuf)) + : gai_strerror (status)); return (-1); } @@ -257,7 +155,7 @@ static int net_open (char *host, char *service, int port) if (sd < 0) { - DBG ("Unable to open a socket"); + DEBUG ("Unable to open a socket"); freeaddrinfo (ai_return); return (-1); } @@ -268,12 +166,17 @@ static int net_open (char *host, char *service, int port) if (status != 0) /* `connect(2)' failed */ { - DBG ("connect failed: %s", strerror (errno)); + char errbuf[1024]; + DEBUG ("connect failed: %s", + sstrerror (errno, errbuf, sizeof (errbuf))); + close (sd); return (-1); } + DEBUG ("Done opening a socket %i", sd); + return (sd); -} /* int net_open(char *host, char *service, int port) */ +} /* int net_open (char *host, char *service, int port) */ /* * Receive a message from the other end. Each message consists of @@ -284,37 +187,36 @@ 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; + 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"); + DEBUG ("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 @@ -323,391 +225,222 @@ 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; + 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); } /* Get and print status from apcupsd NIS server */ -static int do_pthreads_status (char *host, int port, +static int apc_query_server (char *host, int port, struct apc_detail_s *apcups_detail) { - int sockfd; int n; - char recvline[MAXSTRING + 1]; + char recvline[1024]; char *tokptr; + char *toksaveptr; char *key; double value; + + static complain_t compl; + #if APCMAIN # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val) #else # define PRINT_VALUE(name, val) /**/ #endif - /* TODO: Keep the socket open, if possible */ - if ((sockfd = net_open (host, NULL, port)) < 0) + if (global_sockfd < 0) { - syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed."); - return (-1); + if ((global_sockfd = net_open (host, NULL, port)) < 0) + { + plugin_complain (LOG_ERR, &compl, "apcups plugin: " + "Connecting to the apcupsd failed."); + return (-1); + } + else + { + plugin_relief (LOG_NOTICE, &compl, "apcups plugin: " + "Connection re-established to the apcupsd."); + } } - net_send (sockfd, "status", 6); + if (net_send (&global_sockfd, "status", 6) < 0) + { + ERROR ("apcups plugin: Writing to the socket failed."); + return (-1); + } - while ((n = net_recv (sockfd, recvline, sizeof (recvline))) > 0) + while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0) { + assert (n < sizeof (recvline)); recvline[n] = '\0'; #if APCMAIN printf ("net_recv = `%s';\n", recvline); #endif /* if APCMAIN */ - tokptr = strtok (recvline, ":"); + toksaveptr = NULL; + tokptr = strtok_r (recvline, " :\t", &toksaveptr); while (tokptr != NULL) { key = tokptr; - if ((tokptr = strtok (NULL, " \t")) == NULL) + if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == 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; - else - { - syslog (LOG_WARNING, "apcups plugin: Received unknown property from apcupsd: `%s' = %f", - key, value); - } - tokptr = strtok (NULL, ":"); + tokptr = strtok_r (NULL, ":", &toksaveptr); } /* while (tokptr != NULL) */ } - - net_close (sockfd); - + if (n < 0) { - syslog (LOG_WARNING, "apcups plugin: Error reading from socket"); + WARNING ("apcups plugin: Error reading from socket"); return (-1); } return (0); } -#ifdef APCMAIN -int main(int argc, char **argv) -{ - /* we are not really going to use this */ - struct apc_detail_s apcups_detail; - - if (!*host || strcmp(host, "0.0.0.0") == 0) - host = "localhost"; - - do_pthreads_status(host, port, &apcups_detail); - - return 0; -} -#else -static void apcups_init (void) -{ - return; -} - -static int apcups_config (char *key, char *value) +static int apcups_config (const char *key, const char *value) { - 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); - } - return(0); -} - -#define BUFSIZE 256 -static void apcups_submit (char *host, - struct apc_detail_s *apcups_detail) -{ - char buf[BUFSIZE]; - - if (snprintf (buf, BUFSIZE, "%u:%f:%f", - (unsigned int) curtime, - apcups_detail->linev, - apcups_detail->outputv) >= BUFSIZE) - return; - - plugin_submit (MODULE_NAME, host, buf); -} - -static void apc_bvolt_submit (char *host, - struct apc_detail_s *apcups_detail) -{ - char buf[BUFSIZE]; - - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->battv) >= BUFSIZE) - return; - - plugin_submit ("apcups_bvolt", host, buf); -} - -static void apc_load_submit (char *host, - struct apc_detail_s *apcups_detail) -{ - char buf[BUFSIZE]; - - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->loadpct) >= BUFSIZE) - return; - - plugin_submit ("apcups_load", host, buf); -} - -static void apc_charge_submit (char *host, - struct apc_detail_s *apcups_detail) -{ - char buf[BUFSIZE]; - - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->bcharge) >= BUFSIZE) - return; - - plugin_submit ("apcups_charge", host, buf); + if (strcasecmp (key, "host") == 0) + { + if (conf_host != NULL) + { + free (conf_host); + conf_host = NULL; + } + if ((conf_host = strdup (value)) == NULL) + return (1); + } + else if (strcasecmp (key, "Port") == 0) + { + int port_tmp = atoi (value); + if (port_tmp < 1 || port_tmp > 65535) + { + WARNING ("apcups plugin: Invalid port: %i", port_tmp); + return (1); + } + conf_port = port_tmp; + } + else + { + return (-1); + } + return (0); } -static void apc_temp_submit (char *host, - struct apc_detail_s *apcups_detail) +static void apc_submit_generic (char *type, char *type_inst, double value) { - char buf[BUFSIZE]; + value_t values[1]; + value_list_t vl = VALUE_LIST_INIT; - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->itemp) >= BUFSIZE) - return; - - plugin_submit ("apcups_temp", host, buf); -} + values[0].gauge = value; -static void apc_time_submit (char *host, - struct apc_detail_s *apcups_detail) -{ - char buf[BUFSIZE]; + vl.values = values; + vl.values_len = 1; + vl.time = time (NULL); + strcpy (vl.host, hostname_g); + strcpy (vl.plugin, "apcups"); + strcpy (vl.plugin_instance, ""); + strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance)); - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->timeleft) >= BUFSIZE) - return; - - plugin_submit ("apcups_time", host, buf); + plugin_dispatch_values (type, &vl); } -static void apc_freq_submit (char *host, - struct apc_detail_s *apcups_detail) +static void apc_submit (struct apc_detail_s *apcups_detail) { - char buf[BUFSIZE]; - - if (snprintf (buf, BUFSIZE, "%u:%f", - (unsigned int) curtime, - apcups_detail->linefreq) >= BUFSIZE) - return; - - plugin_submit ("apcups_freq", host, buf); + 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_frequency", "input", apcups_detail->linefreq); } -#undef BUFSIZE -static void apcups_read (void) +static int apcups_read (void) { - struct apc_detail_s apcups_detail; - int status; - - 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; - - - if (!*host || strcmp(host, "0.0.0.0") == 0) - host = "localhost"; + struct apc_detail_s apcups_detail; + int status; + + apcups_detail.linev = -1.0; + apcups_detail.outputv = -1.0; + apcups_detail.battv = -1.0; + apcups_detail.loadpct = -1.0; + apcups_detail.bcharge = -1.0; + apcups_detail.timeleft = -1.0; + apcups_detail.itemp = -300.0; + apcups_detail.linefreq = -1.0; - status = do_pthreads_status(host, 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; - - 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); -} - - -static void apcups_write (char *host, char *inst, char *val) -{ - 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); -} - -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); -} - -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); -} - -static void apc_charge_write (char *host, char *inst, char *val) -{ - 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); -} - -static void apc_temp_write (char *host, char *inst, char *val) -{ - 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); -} + /* + * if we did not connect then do not bother submitting + * zeros. We want rrd files to have NAN. + */ + if (status != 0) + { + DEBUG ("apc_query_server (%s, %i) = %i", + conf_host == NULL + ? APCUPS_DEFAULT_HOST + : conf_host, + conf_port, status); + return (-1); + } -static void apc_time_write (char *host, char *inst, char *val) -{ - char file[512]; - int status; - - 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); -} + apc_submit (&apcups_detail); -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); -} + return (0); +} /* apcups_read */ void module_register (void) { - plugin_register (MODULE_NAME, apcups_init, apcups_read, apcups_write); - plugin_register ("apcups_bvolt", NULL, NULL, apc_bvolt_write); - plugin_register ("apcups_load", NULL, NULL, apc_load_write); - plugin_register ("apcups_charge", NULL, NULL, apc_charge_write); - plugin_register ("apcups_temp", NULL, NULL, apc_temp_write); - plugin_register ("apcups_time", NULL, NULL, apc_time_write); - plugin_register ("apcups_freq", NULL, NULL, apc_freq_write); - cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num); -} - -#endif /* ifdef 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); +} /* void module_register */