1 /*
2 * collectd - src/apcups.c
3 * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
4 * Copyright (C) 2000-2004 Kern Sibbald
5 * Copyright (C) 1996-99 Andre M. Hedrick <andre at suse.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of version 2 of the GNU General
9 * Public License as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the Free
18 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 * MA 02111-1307, USA.
20 *
21 * Authors:
22 * Anthony Gialluca <tonyabg at charter.net>
23 **/
25 /*
26 * FIXME: Don't know why but without this here atof() was not returning
27 * correct values for me. This is behavior that I don't understand and
28 * should be examined in closer detail.
29 */
30 #include <stdlib.h>
32 #include "collectd.h"
33 #include "common.h" /* rrd_update_file */
34 #include "plugin.h" /* plugin_register, plugin_submit */
35 #include "configfile.h" /* cf_register */
36 #include "utils_debug.h"
38 #if HAVE_SYS_TYPES_H
39 # include <sys/types.h>
40 #endif
41 #if HAVE_SYS_SOCKET_H
42 # include <sys/socket.h>
43 #endif
44 #if HAVE_NETDB_H
45 # include <netdb.h>
46 #endif
48 #if HAVE_NETINET_IN_H
49 # include <netinet/in.h>
50 #endif
52 #ifndef APCMAIN
53 # define APCMAIN 0
54 #endif
56 #define NISPORT 3551
57 #define MAXSTRING 256
58 #define MODULE_NAME "apcups"
60 #define APCUPS_DEFAULT_HOST "localhost"
62 /* Default values for contacting daemon */
63 static char *global_host = NULL;
64 static int global_port = NISPORT;
66 /*
67 * The following are only if not compiled to test the module with its own main.
68 */
69 #if !APCMAIN
70 static char *bvolt_file_template = "apcups/voltage-%s.rrd";
71 static char *bvolt_ds_def[] =
72 {
73 "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":0:U",
74 };
75 static int bvolt_ds_num = 1;
77 static char *load_file_template = "apcups/charge_percent.rrd";
78 static char *load_ds_def[] =
79 {
80 "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
81 };
82 static int load_ds_num = 1;
84 static char *charge_file_template = "apcups/charge.rrd";
85 static char *charge_ds_def[] =
86 {
87 "DS:charge:GAUGE:"COLLECTD_HEARTBEAT":0:U",
88 };
89 static int charge_ds_num = 1;
91 static char *time_file_template = "apcups/time.rrd";
92 static char *time_ds_def[] =
93 {
94 "DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100",
95 };
96 static int time_ds_num = 1;
98 static char *temp_file_template = "apcups/temperature.rrd";
99 static char *temp_ds_def[] =
100 {
101 /* -273.15 is absolute zero */
102 "DS:temperature:GAUGE:"COLLECTD_HEARTBEAT":-274:U",
103 };
104 static int temp_ds_num = 1;
106 static char *freq_file_template = "apcups/frequency-%s.rrd";
107 static char *freq_ds_def[] =
108 {
109 "DS:frequency:GAUGE:"COLLECTD_HEARTBEAT":0:U",
110 };
111 static int freq_ds_num = 1;
113 static char *config_keys[] =
114 {
115 "Host",
116 "Port",
117 NULL
118 };
119 static int config_keys_num = 2;
121 #endif /* if APCMAIN */
123 struct apc_detail_s
124 {
125 double linev;
126 double loadpct;
127 double bcharge;
128 double timeleft;
129 double outputv;
130 double itemp;
131 double battv;
132 double linefreq;
133 };
135 #define BIG_BUF 4096
137 /*
138 * Read nbytes from the network.
139 * It is possible that the total bytes require in several
140 * read requests
141 */
142 static int read_nbytes (int *fd, char *ptr, int nbytes)
143 {
144 int nleft;
145 int nread;
147 nleft = nbytes;
148 nread = -1;
150 assert (*fd >= 0);
152 while ((nleft > 0) && (nread != 0))
153 {
154 nread = read (*fd, ptr, nleft);
156 if (nread == -1 && (errno == EINTR || errno == EAGAIN))
157 continue;
159 if (nread == -1)
160 {
161 *fd = -1;
162 syslog (LOG_ERR, "apcups plugin: write failed: %s", strerror (errno));
163 return (-1);
164 }
166 nleft -= nread;
167 ptr += nread;
168 }
170 return (nbytes - nleft);
171 }
173 /*
174 * Write nbytes to the network.
175 * It may require several writes.
176 */
177 static int write_nbytes (int *fd, void *buf, int buflen)
178 {
179 int nleft;
180 int nwritten;
181 char *ptr;
183 assert (buflen > 0);
184 assert (*fd >= 0);
186 ptr = (char *) buf;
188 nleft = buflen;
189 while (nleft > 0)
190 {
191 nwritten = write (*fd, ptr, nleft);
193 if ((nwritten == -1) && ((errno == EAGAIN) || (errno == EINTR)))
194 continue;
196 if (nwritten == -1)
197 {
198 syslog (LOG_ERR, "Writing to socket failed: %s", strerror (errno));
199 *fd = -1;
200 return (-1);
201 }
203 nleft -= nwritten;
204 ptr += nwritten;
205 }
207 /* If we get here, (nleft <= 0) is true */
208 return (buflen);
209 }
211 /* Close the network connection */
212 static void net_close (int *fd)
213 {
214 short pktsiz = 0;
216 assert (*fd >= 0);
218 /* send EOF sentinel */
219 write_nbytes (fd, &pktsiz, sizeof (short));
221 close (*fd);
222 *fd = -1;
223 }
226 /*
227 * Open a TCP connection to the UPS network server
228 * Returns -1 on error
229 * Returns socket file descriptor otherwise
230 */
231 static int net_open (char *host, char *service, int port)
232 {
233 int sd;
234 int status;
235 char port_str[8];
236 struct addrinfo ai_hints;
237 struct addrinfo *ai_return;
238 struct addrinfo *ai_list;
240 assert ((port > 0x00000000) && (port <= 0x0000FFFF));
242 /* Convert the port to a string */
243 snprintf (port_str, 8, "%i", port);
244 port_str[7] = '\0';
246 /* Resolve name */
247 memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
248 ai_hints.ai_family = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
249 ai_hints.ai_socktype = SOCK_STREAM;
251 status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
252 if (status != 0)
253 {
254 DBG ("getaddrinfo failed: %s", status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
255 return (-1);
256 }
258 /* Create socket */
259 sd = -1;
260 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
261 {
262 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
263 if (sd >= 0)
264 break;
265 }
266 /* `ai_list' still holds the current description of the socket.. */
268 if (sd < 0)
269 {
270 DBG ("Unable to open a socket");
271 freeaddrinfo (ai_return);
272 return (-1);
273 }
275 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
277 freeaddrinfo (ai_return);
279 if (status != 0) /* `connect(2)' failed */
280 {
281 DBG ("connect failed: %s", strerror (errno));
282 return (-1);
283 }
285 return (sd);
286 } /* int net_open (char *host, char *service, int port) */
288 /*
289 * Receive a message from the other end. Each message consists of
290 * two packets. The first is a header that contains the size
291 * of the data that follows in the second packet.
292 * Returns number of bytes read
293 * Returns 0 on end of file
294 * Returns -1 on hard end of file (i.e. network connection close)
295 * Returns -2 on error
296 */
297 static int net_recv (int *sockfd, char *buf, int buflen)
298 {
299 int nbytes;
300 short pktsiz;
302 /* get data size -- in short */
303 if ((nbytes = read_nbytes (sockfd, (char *) &pktsiz, sizeof (short))) <= 0)
304 return (-1);
306 if (nbytes != sizeof (short))
307 return (-2);
309 pktsiz = ntohs (pktsiz);
310 if (pktsiz > buflen)
311 {
312 DBG ("record length too large");
313 return (-2);
314 }
316 if (pktsiz == 0)
317 return (0);
319 /* now read the actual data */
320 if ((nbytes = read_nbytes (sockfd, buf, pktsiz)) <= 0)
321 return (-2);
323 if (nbytes != pktsiz)
324 return (-2);
326 return (nbytes);
327 } /* static int net_recv (int sockfd, char *buf, int buflen) */
329 /*
330 * Send a message over the network. The send consists of
331 * two network packets. The first is sends a short containing
332 * the length of the data packet which follows.
333 * Returns zero on success
334 * Returns non-zero on error
335 */
336 static int net_send (int *sockfd, char *buff, int len)
337 {
338 int rc;
339 short packet_size;
341 assert (len > 0);
343 /* send short containing size of data packet */
344 packet_size = htons ((short) len);
346 rc = write_nbytes (sockfd, &packet_size, sizeof (packet_size));
347 if (rc != sizeof (packet_size))
348 return (-1);
350 /* send data packet */
351 rc = write_nbytes (sockfd, buff, len);
352 if (rc != len)
353 return (-1);
355 return (0);
356 }
358 /* Get and print status from apcupsd NIS server */
359 static int apc_query_server (char *host, int port,
360 struct apc_detail_s *apcups_detail)
361 {
362 int n;
363 char recvline[1024];
364 char *tokptr;
365 char *key;
366 double value;
368 static int sockfd = -1;
369 static unsigned int complain = 0;
371 #if APCMAIN
372 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
373 #else
374 # define PRINT_VALUE(name, val) /**/
375 #endif
377 if (sockfd < 0)
378 {
379 if ((sockfd = net_open (host, NULL, port)) < 0)
380 {
381 /* Complain once every six hours. */
382 int complain_step = 21600 / atoi (COLLECTD_STEP);
384 if ((complain % complain_step) == 0)
385 syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed.");
386 complain++;
388 return (-1);
389 }
390 else if (complain > 1)
391 {
392 syslog (LOG_NOTICE, "apcups plugin: Connection re-established to the apcupsd.");
393 complain = 0;
394 }
395 }
397 if (net_send (&sockfd, "status", 6) < 0)
398 {
399 syslog (LOG_ERR, "apcups plugin: Writing to the socket failed.");
400 return (-1);
401 }
403 while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0)
404 {
405 assert (n < sizeof (recvline));
406 recvline[n] = '\0';
407 #if APCMAIN
408 printf ("net_recv = `%s';\n", recvline);
409 #endif /* if APCMAIN */
411 tokptr = strtok (recvline, ":");
412 while (tokptr != NULL)
413 {
414 key = tokptr;
415 if ((tokptr = strtok (NULL, " \t")) == NULL)
416 continue;
417 value = atof (tokptr);
418 PRINT_VALUE (key, value);
420 if (strcmp ("LINEV", key) == 0)
421 apcups_detail->linev = value;
422 else if (strcmp ("BATTV", key) == 0)
423 apcups_detail->battv = value;
424 else if (strcmp ("ITEMP", key) == 0)
425 apcups_detail->itemp = value;
426 else if (strcmp ("LOADPCT", key) == 0)
427 apcups_detail->loadpct = value;
428 else if (strcmp ("BCHARGE", key) == 0)
429 apcups_detail->bcharge = value;
430 else if (strcmp ("OUTPUTV", key) == 0)
431 apcups_detail->outputv = value;
432 else if (strcmp ("LINEFREQ", key) == 0)
433 apcups_detail->linefreq = value;
434 else if (strcmp ("TIMELEFT", key) == 0)
435 apcups_detail->timeleft = value;
437 tokptr = strtok (NULL, ":");
438 } /* while (tokptr != NULL) */
439 }
441 if (n < 0)
442 {
443 syslog (LOG_WARNING, "apcups plugin: Error reading from socket");
444 return (-1);
445 } else {
446 /* close the opened socket */
447 net_close(&sockfd);
448 }
450 return (0);
451 }
453 #if APCMAIN
454 /*
455 * This is used for testing apcups in a standalone mode.
456 * Usefull for debugging.
457 */
458 int main (int argc, char **argv)
459 {
460 /* we are not really going to use this */
461 struct apc_detail_s apcups_detail;
463 openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1, LOG_USER);
465 if (global_host == NULL || strcmp (global_host, "0.0.0.0") == 0)
466 global_host = "localhost";
468 if(apc_query_server (global_host, global_port, &apcups_detail) < 0)
469 {
470 printf("apcups: Failed...\n");
471 return(-1);
472 }
474 return 0;
475 }
476 #else
477 static int apcups_config (char *key, char *value)
478 {
479 if (strcasecmp (key, "host") == 0)
480 {
481 if (global_host != NULL)
482 {
483 free (global_host);
484 global_host = NULL;
485 }
486 if ((global_host = strdup (value)) == NULL)
487 return (1);
488 }
489 else if (strcasecmp (key, "Port") == 0)
490 {
491 int port_tmp = atoi (value);
492 if (port_tmp < 1 || port_tmp > 65535)
493 {
494 syslog (LOG_WARNING, "apcups plugin: Invalid port: %i", port_tmp);
495 return (1);
496 }
497 global_port = port_tmp;
498 }
499 else
500 {
501 return (-1);
502 }
503 return (0);
504 }
506 static void apcups_init (void)
507 {
508 return;
509 }
511 static void apc_write_voltage (char *host, char *inst, char *val)
512 {
513 char file[512];
514 int status;
516 status = snprintf (file, 512, bvolt_file_template, inst);
517 if ((status < 1) || (status >= 512))
518 return;
520 rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num);
521 }
523 static void apc_write_charge (char *host, char *inst, char *val)
524 {
525 rrd_update_file (host, charge_file_template, val, charge_ds_def, charge_ds_num);
526 }
528 static void apc_write_percent (char *host, char *inst, char *val)
529 {
530 rrd_update_file (host, load_file_template, val, load_ds_def, load_ds_num);
531 }
533 static void apc_write_timeleft (char *host, char *inst, char *val)
534 {
535 rrd_update_file (host, time_file_template, val, time_ds_def, time_ds_num);
536 }
538 static void apc_write_temperature (char *host, char *inst, char *val)
539 {
540 rrd_update_file (host, temp_file_template, val, temp_ds_def, temp_ds_num);
541 }
543 static void apc_write_frequency (char *host, char *inst, char *val)
544 {
545 char file[512];
546 int status;
548 status = snprintf (file, 512, freq_file_template, inst);
549 if ((status < 1) || (status >= 512))
550 return;
552 rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
553 }
555 static void apc_submit_generic (char *type, char *inst,
556 double value)
557 {
558 char buf[512];
559 int status;
561 status = snprintf (buf, 512, "%u:%f",
562 (unsigned int) curtime, value);
563 if ((status < 1) || (status >= 512))
564 return;
566 plugin_submit (type, inst, buf);
567 }
569 static void apc_submit (struct apc_detail_s *apcups_detail)
570 {
571 apc_submit_generic ("apcups_voltage", "input", apcups_detail->linev);
572 apc_submit_generic ("apcups_voltage", "output", apcups_detail->outputv);
573 apc_submit_generic ("apcups_voltage", "battery", apcups_detail->battv);
574 apc_submit_generic ("apcups_charge", "-", apcups_detail->bcharge);
575 apc_submit_generic ("apcups_charge_pct", "-", apcups_detail->loadpct);
576 apc_submit_generic ("apcups_timeleft", "-", apcups_detail->timeleft);
577 apc_submit_generic ("apcups_temp", "-", apcups_detail->itemp);
578 apc_submit_generic ("apcups_frequency", "input", apcups_detail->linefreq);
579 }
581 static void apcups_read (void)
582 {
583 struct apc_detail_s apcups_detail;
584 int status;
586 apcups_detail.linev = -1.0;
587 apcups_detail.outputv = -1.0;
588 apcups_detail.battv = -1.0;
589 apcups_detail.loadpct = -1.0;
590 apcups_detail.bcharge = -1.0;
591 apcups_detail.timeleft = -1.0;
592 apcups_detail.itemp = -300.0;
593 apcups_detail.linefreq = -1.0;
595 status = apc_query_server (global_host == NULL
596 ? APCUPS_DEFAULT_HOST
597 : global_host,
598 global_port, &apcups_detail);
600 /*
601 * if we did not connect then do not bother submitting
602 * zeros. We want rrd files to have NAN.
603 */
604 if (status != 0)
605 return;
607 apc_submit (&apcups_detail);
608 } /* apcups_read */
610 void module_register (void)
611 {
612 plugin_register (MODULE_NAME, apcups_init, apcups_read, NULL);
613 plugin_register ("apcups_voltage", NULL, NULL, apc_write_voltage);
614 plugin_register ("apcups_charge", NULL, NULL, apc_write_charge);
615 plugin_register ("apcups_charge_pct", NULL, NULL, apc_write_percent);
616 plugin_register ("apcups_timeleft", NULL, NULL, apc_write_timeleft);
617 plugin_register ("apcups_temp", NULL, NULL, apc_write_temperature);
618 plugin_register ("apcups_frequency", NULL, NULL, apc_write_frequency);
619 cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num);
620 }
622 #endif /* if APCMAIN */
623 #undef MODULE_NAME