Code

Merge branch 'collectd-5.4' into collectd-5.5
[collectd.git] / src / apcups.c
1 /*
2  * collectd - src/apcups.c
3  * Copyright (C) 2006-2012  Florian octo Forster
4  * Copyright (C) 2006       Anthony Gialluca <tonyabg at charter.net>
5  * Copyright (C) 2000-2004  Kern Sibbald
6  * Copyright (C) 1996-1999  Andre M. Hedrick <andre at suse.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of version 2 of the GNU General
10  * Public License as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public
18  * License along with this program; if not, write to the Free
19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
20  * MA 02111-1307, USA.
21  *
22  * Authors:
23  *   Anthony Gialluca <tonyabg at charter.net>
24  *   Florian octo Forster <octo at collectd.org>
25  **/
27 #include "collectd.h"
28 #include "common.h"      /* rrd_update_file */
29 #include "plugin.h"      /* plugin_register, plugin_submit */
30 #include "configfile.h"  /* cf_register */
32 #if HAVE_SYS_TYPES_H
33 # include <sys/types.h>
34 #endif
35 #if HAVE_SYS_SOCKET_H
36 # include <sys/socket.h>
37 #endif
38 #if HAVE_NETDB_H
39 # include <netdb.h>
40 #endif
42 #if HAVE_NETINET_IN_H
43 # include <netinet/in.h>
44 #endif
46 #define NISPORT 3551
47 #define MAXSTRING               256
48 #define MODULE_NAME "apcups"
50 #define APCUPS_DEFAULT_HOST "localhost"
52 /*
53  * Private data types
54  */
55 struct apc_detail_s
56 {
57         double linev;
58         double loadpct;
59         double bcharge;
60         double timeleft;
61         double outputv;
62         double itemp;
63         double battv;
64         double linefreq;
65 };
67 /*
68  * Private variables
69  */
70 /* Default values for contacting daemon */
71 static char *conf_host = NULL;
72 static int   conf_port = NISPORT;
73 /* Defaults to false for backwards compatibility. */
74 static _Bool conf_report_seconds = 0;
76 static int global_sockfd = -1;
78 static int count_retries = 0;
79 static int count_iterations = 0;
80 static _Bool close_socket = 0;
82 static const char *config_keys[] =
83 {
84         "Host",
85         "Port",
86         "ReportSeconds"
87 };
88 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
90 static int net_shutdown (int *fd)
91 {
92         uint16_t packet_size = 0;
94         if ((fd == NULL) || (*fd < 0))
95                 return (EINVAL);
97         swrite (*fd, (void *) &packet_size, sizeof (packet_size));
98         close (*fd);
99         *fd = -1;
101         return (0);
102 } /* int net_shutdown */
104 /* Close the network connection */
105 static int apcups_shutdown (void)
107         if (global_sockfd < 0)
108                 return (0);
110         net_shutdown (&global_sockfd);
111         return (0);
112 } /* int apcups_shutdown */
114 /*
115  * Open a TCP connection to the UPS network server
116  * Returns -1 on error
117  * Returns socket file descriptor otherwise
118  */
119 static int net_open (char *host, int port)
121         int              sd;
122         int              status;
123         char             port_str[8];
124         struct addrinfo  ai_hints;
125         struct addrinfo *ai_return;
126         struct addrinfo *ai_list;
128         assert ((port > 0x00000000) && (port <= 0x0000FFFF));
130         /* Convert the port to a string */
131         ssnprintf (port_str, sizeof (port_str), "%i", port);
133         /* Resolve name */
134         memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
135         ai_hints.ai_family   = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
136         ai_hints.ai_socktype = SOCK_STREAM;
138         status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
139         if (status != 0)
140         {
141                 char errbuf[1024];
142                 INFO ("apcups plugin: getaddrinfo failed: %s",
143                                 (status == EAI_SYSTEM)
144                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
145                                 : gai_strerror (status));
146                 return (-1);
147         }
149         /* Create socket */
150         sd = -1;
151         for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
152         {
153                 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
154                 if (sd >= 0)
155                         break;
156         }
157         /* `ai_list' still holds the current description of the socket.. */
159         if (sd < 0)
160         {
161                 DEBUG ("apcups plugin: Unable to open a socket");
162                 freeaddrinfo (ai_return);
163                 return (-1);
164         }
166         status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
168         freeaddrinfo (ai_return);
170         if (status != 0) /* `connect(2)' failed */
171         {
172                 char errbuf[1024];
173                 INFO ("apcups plugin: connect failed: %s",
174                                 sstrerror (errno, errbuf, sizeof (errbuf)));
175                 close (sd);
176                 return (-1);
177         }
179         DEBUG ("apcups plugin: Done opening a socket %i", sd);
181         return (sd);
182 } /* int net_open (char *host, char *service, int port) */
184 /*
185  * Receive a message from the other end. Each message consists of
186  * two packets. The first is a header that contains the size
187  * of the data that follows in the second packet.
188  * Returns number of bytes read
189  * Returns 0 on end of file
190  * Returns -1 on hard end of file (i.e. network connection close)
191  * Returns -2 on error
192  */
193 static int net_recv (int *sockfd, char *buf, int buflen)
195         uint16_t packet_size;
197         /* get data size -- in short */
198         if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
199         {
200                 close (*sockfd);
201                 *sockfd = -1;
202                 return (-1);
203         }
205         packet_size = ntohs (packet_size);
206         if (packet_size > buflen)
207         {
208                 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
209                                 "but have only %i bytes of buffer available.",
210                                 packet_size, buflen);
211                 close (*sockfd);
212                 *sockfd = -1;
213                 return (-2);
214         }
216         if (packet_size == 0)
217                 return (0);
219         /* now read the actual data */
220         if (sread (*sockfd, (void *) buf, packet_size) != 0)
221         {
222                 close (*sockfd);
223                 *sockfd = -1;
224                 return (-1);
225         }
227         return ((int) packet_size);
228 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
230 /*
231  * Send a message over the network. The send consists of
232  * two network packets. The first is sends a short containing
233  * the length of the data packet which follows.
234  * Returns zero on success
235  * Returns non-zero on error
236  */
237 static int net_send (int *sockfd, char *buff, int len)
239         uint16_t packet_size;
241         assert (len > 0);
242         assert (*sockfd >= 0);
244         /* send short containing size of data packet */
245         packet_size = htons ((uint16_t) len);
247         if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
248         {
249                 close (*sockfd);
250                 *sockfd = -1;
251                 return (-1);
252         }
254         /* send data packet */
255         if (swrite (*sockfd, (void *) buff, len) != 0)
256         {
257                 close (*sockfd);
258                 *sockfd = -1;
259                 return (-2);
260         }
262         return (0);
265 /* Get and print status from apcupsd NIS server */
266 static int apc_query_server (char *host, int port,
267                 struct apc_detail_s *apcups_detail)
269         int     n;
270         char    recvline[1024];
271         char   *tokptr;
272         char   *toksaveptr;
273         char   *key;
274         double  value;
275         _Bool retry = 1;
276         int status;
278 #if APCMAIN
279 # define PRINT_VALUE(name, val) printf("  Found property: name = %s; value = %f;\n", name, val)
280 #else
281 # define PRINT_VALUE(name, val) /**/
282 #endif
284         while (retry)
285         {
286                 if (global_sockfd < 0)
287                 {
288                         global_sockfd = net_open (host, port);
289                         if (global_sockfd < 0)
290                         {
291                                 ERROR ("apcups plugin: Connecting to the "
292                                                 "apcupsd failed.");
293                                 return (-1);
294                         }
295                 }
298                 status = net_send (&global_sockfd, "status", strlen ("status"));
299                 if (status != 0)
300                 {
301                         /* net_send is closing the socket on error. */
302                         assert (global_sockfd < 0);
303                         if (retry)
304                         {
305                                 retry = 0;
306                                 count_retries++;
307                                 continue;
308                         }
310                         ERROR ("apcups plugin: Writing to the socket failed.");
311                         return (-1);
312                 }
314                 break;
315         } /* while (retry) */
317         /* When collectd's collection interval is larger than apcupsd's
318          * timeout, we would have to retry / re-connect each iteration. Try to
319          * detect this situation and shut down the socket gracefully in that
320          * case. Otherwise, keep the socket open to avoid overhead. */
321         count_iterations++;
322         if ((count_iterations == 10) && (count_retries > 2))
323         {
324                 NOTICE ("apcups plugin: There have been %i retries in the "
325                                 "first %i iterations. Will close the socket "
326                                 "in future iterations.",
327                                 count_retries, count_iterations);
328                 close_socket = 1;
329         }
331         while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
332         {
333                 assert ((unsigned int)n < sizeof (recvline));
334                 recvline[n] = '\0';
335 #if APCMAIN
336                 printf ("net_recv = `%s';\n", recvline);
337 #endif /* if APCMAIN */
339                 toksaveptr = NULL;
340                 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
341                 while (tokptr != NULL)
342                 {
343                         key = tokptr;
344                         if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
345                                 continue;
346                         value = atof (tokptr);
348                         PRINT_VALUE (key, value);
350                         if (strcmp ("LINEV", key) == 0)
351                                 apcups_detail->linev = value;
352                         else if (strcmp ("BATTV", key) == 0)
353                                 apcups_detail->battv = value;
354                         else if (strcmp ("ITEMP", key) == 0)
355                                 apcups_detail->itemp = value;
356                         else if (strcmp ("LOADPCT", key) == 0)
357                                 apcups_detail->loadpct = value;
358                         else if (strcmp ("BCHARGE", key) == 0)
359                                 apcups_detail->bcharge = value;
360                         else if (strcmp ("OUTPUTV", key) == 0)
361                                 apcups_detail->outputv = value;
362                         else if (strcmp ("LINEFREQ", key) == 0)
363                                 apcups_detail->linefreq = value;
364                         else if (strcmp ("TIMELEFT", key) == 0)
365                         {
366                                 /* Convert minutes to seconds if requested by
367                                  * the user. */
368                                 if (conf_report_seconds)
369                                         value *= 60.0;
370                                 apcups_detail->timeleft = value;
371                         }
373                         tokptr = strtok_r (NULL, ":", &toksaveptr);
374                 } /* while (tokptr != NULL) */
375         }
376         status = errno; /* save errno, net_shutdown() may re-set it. */
378         if (close_socket)
379                 net_shutdown (&global_sockfd);
381         if (n < 0)
382         {
383                 char errbuf[1024];
384                 ERROR ("apcups plugin: Reading from socket failed: %s",
385                                 sstrerror (status, errbuf, sizeof (errbuf)));
386                 return (-1);
387         }
389         return (0);
392 static int apcups_config (const char *key, const char *value)
394         if (strcasecmp (key, "host") == 0)
395         {
396                 if (conf_host != NULL)
397                 {
398                         free (conf_host);
399                         conf_host = NULL;
400                 }
401                 if ((conf_host = strdup (value)) == NULL)
402                         return (1);
403         }
404         else if (strcasecmp (key, "Port") == 0)
405         {
406                 int port_tmp = atoi (value);
407                 if (port_tmp < 1 || port_tmp > 65535)
408                 {
409                         WARNING ("apcups plugin: Invalid port: %i", port_tmp);
410                         return (1);
411                 }
412                 conf_port = port_tmp;
413         }
414         else if (strcasecmp (key, "ReportSeconds") == 0)
415         {
416                 if (IS_TRUE (value))
417                         conf_report_seconds = 1;
418                 else
419                         conf_report_seconds = 0;
420         }
421         else
422         {
423                 return (-1);
424         }
425         return (0);
428 static void apc_submit_generic (char *type, char *type_inst, double value)
430         value_t values[1];
431         value_list_t vl = VALUE_LIST_INIT;
433         values[0].gauge = value;
435         vl.values = values;
436         vl.values_len = 1;
437         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
438         sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
439         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
440         sstrncpy (vl.type, type, sizeof (vl.type));
441         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
443         plugin_dispatch_values (&vl);
446 static void apc_submit (struct apc_detail_s *apcups_detail)
448         apc_submit_generic ("voltage",    "input",   apcups_detail->linev);
449         apc_submit_generic ("voltage",    "output",  apcups_detail->outputv);
450         apc_submit_generic ("voltage",    "battery", apcups_detail->battv);
451         apc_submit_generic ("charge",     "",        apcups_detail->bcharge);
452         apc_submit_generic ("percent",    "load",    apcups_detail->loadpct);
453         apc_submit_generic ("timeleft",   "",        apcups_detail->timeleft);
454         apc_submit_generic ("temperature", "",       apcups_detail->itemp);
455         apc_submit_generic ("frequency",  "input",   apcups_detail->linefreq);
458 static int apcups_read (void)
460         struct apc_detail_s apcups_detail;
461         int status;
463         apcups_detail.linev    =   -1.0;
464         apcups_detail.outputv  =   -1.0;
465         apcups_detail.battv    =   -1.0;
466         apcups_detail.loadpct  =   -1.0;
467         apcups_detail.bcharge  =   -1.0;
468         apcups_detail.timeleft =    NAN;
469         apcups_detail.itemp    = -300.0;
470         apcups_detail.linefreq =   -1.0;
472         status = apc_query_server (conf_host == NULL
473                         ? APCUPS_DEFAULT_HOST
474                         : conf_host,
475                         conf_port, &apcups_detail);
477         /*
478          * if we did not connect then do not bother submitting
479          * zeros. We want rrd files to have NAN.
480          */
481         if (status != 0)
482         {
483                 DEBUG ("apcups plugin: apc_query_server (%s, %i) = %i",
484                                 conf_host == NULL
485                                 ? APCUPS_DEFAULT_HOST
486                                 : conf_host,
487                                 conf_port, status);
488                 return (-1);
489         }
491         apc_submit (&apcups_detail);
493         return (0);
494 } /* apcups_read */
496 void module_register (void)
498         plugin_register_config ("apcups", apcups_config, config_keys,
499                         config_keys_num);
500         plugin_register_read ("apcups", apcups_read);
501         plugin_register_shutdown ("apcups", apcups_shutdown);
502 } /* void module_register */