1 /*
2 * collectd - src/apcups.c
3 * Copyright (C) 2007 Florian octo Forster
4 * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
5 * Copyright (C) 2000-2004 Kern Sibbald
6 * Copyright (C) 1996-99 Andre M. Hedrick <andre at suse.com>
7 *
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General
11 * Public License as published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public
19 * License along with this program; if not, write to the Free
20 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
21 * MA 02111-1307, USA.
22 *
23 * Authors:
24 * Anthony Gialluca <tonyabg at charter.net>
25 **/
27 /*
28 * FIXME: Don't know why but without this here atof() was not returning
29 * correct values for me. This is behavior that I don't understand and
30 * should be examined in closer detail.
31 */
32 #include <stdlib.h>
34 #include "collectd.h"
35 #include "common.h" /* rrd_update_file */
36 #include "plugin.h" /* plugin_register, plugin_submit */
37 #include "configfile.h" /* cf_register */
39 #if HAVE_SYS_TYPES_H
40 # include <sys/types.h>
41 #endif
42 #if HAVE_SYS_SOCKET_H
43 # include <sys/socket.h>
44 #endif
45 #if HAVE_NETDB_H
46 # include <netdb.h>
47 #endif
49 #if HAVE_NETINET_IN_H
50 # include <netinet/in.h>
51 #endif
53 #define NISPORT 3551
54 #define MAXSTRING 256
55 #define MODULE_NAME "apcups"
57 #define APCUPS_DEFAULT_HOST "localhost"
59 /*
60 * Private data types
61 */
62 struct apc_detail_s
63 {
64 double linev;
65 double loadpct;
66 double bcharge;
67 double timeleft;
68 double outputv;
69 double itemp;
70 double battv;
71 double linefreq;
72 };
74 /*
75 * Private variables
76 */
77 /* Default values for contacting daemon */
78 static char *conf_host = NULL;
79 static int conf_port = NISPORT;
81 static int global_sockfd = -1;
83 static const char *config_keys[] =
84 {
85 "Host",
86 "Port",
87 NULL
88 };
89 static int config_keys_num = 2;
91 /* Close the network connection */
92 static int apcups_shutdown (void)
93 {
94 uint16_t packet_size = 0;
96 if (global_sockfd < 0)
97 return (0);
99 DEBUG ("Gracefully shutting down socket %i.", global_sockfd);
101 /* send EOF sentinel */
102 swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size));
104 close (global_sockfd);
105 global_sockfd = -1;
107 return (0);
108 } /* int apcups_shutdown */
110 /*
111 * Open a TCP connection to the UPS network server
112 * Returns -1 on error
113 * Returns socket file descriptor otherwise
114 */
115 static int net_open (char *host, int port)
116 {
117 int sd;
118 int status;
119 char port_str[8];
120 struct addrinfo ai_hints;
121 struct addrinfo *ai_return;
122 struct addrinfo *ai_list;
124 assert ((port > 0x00000000) && (port <= 0x0000FFFF));
126 /* Convert the port to a string */
127 ssnprintf (port_str, sizeof (port_str), "%i", port);
129 /* Resolve name */
130 memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
131 ai_hints.ai_family = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
132 ai_hints.ai_socktype = SOCK_STREAM;
134 status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
135 if (status != 0)
136 {
137 char errbuf[1024];
138 INFO ("getaddrinfo failed: %s",
139 (status == EAI_SYSTEM)
140 ? sstrerror (errno, errbuf, sizeof (errbuf))
141 : gai_strerror (status));
142 return (-1);
143 }
145 /* Create socket */
146 sd = -1;
147 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
148 {
149 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
150 if (sd >= 0)
151 break;
152 }
153 /* `ai_list' still holds the current description of the socket.. */
155 if (sd < 0)
156 {
157 DEBUG ("Unable to open a socket");
158 freeaddrinfo (ai_return);
159 return (-1);
160 }
162 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
164 freeaddrinfo (ai_return);
166 if (status != 0) /* `connect(2)' failed */
167 {
168 char errbuf[1024];
169 INFO ("connect failed: %s",
170 sstrerror (errno, errbuf, sizeof (errbuf)));
171 close (sd);
172 return (-1);
173 }
175 DEBUG ("Done opening a socket %i", sd);
177 return (sd);
178 } /* int net_open (char *host, char *service, int port) */
180 /*
181 * Receive a message from the other end. Each message consists of
182 * two packets. The first is a header that contains the size
183 * of the data that follows in the second packet.
184 * Returns number of bytes read
185 * Returns 0 on end of file
186 * Returns -1 on hard end of file (i.e. network connection close)
187 * Returns -2 on error
188 */
189 static int net_recv (int *sockfd, char *buf, int buflen)
190 {
191 uint16_t packet_size;
193 /* get data size -- in short */
194 if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
195 {
196 *sockfd = -1;
197 return (-1);
198 }
200 packet_size = ntohs (packet_size);
201 if (packet_size > buflen)
202 {
203 DEBUG ("record length too large");
204 return (-2);
205 }
207 if (packet_size == 0)
208 return (0);
210 /* now read the actual data */
211 if (sread (*sockfd, (void *) buf, packet_size) != 0)
212 {
213 *sockfd = -1;
214 return (-1);
215 }
217 return ((int) packet_size);
218 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
220 /*
221 * Send a message over the network. The send consists of
222 * two network packets. The first is sends a short containing
223 * the length of the data packet which follows.
224 * Returns zero on success
225 * Returns non-zero on error
226 */
227 static int net_send (int *sockfd, char *buff, int len)
228 {
229 uint16_t packet_size;
231 assert (len > 0);
232 assert (*sockfd >= 0);
234 /* send short containing size of data packet */
235 packet_size = htons ((uint16_t) len);
237 if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
238 {
239 *sockfd = -1;
240 return (-1);
241 }
243 /* send data packet */
244 if (swrite (*sockfd, (void *) buff, len) != 0)
245 {
246 *sockfd = -1;
247 return (-2);
248 }
250 return (0);
251 }
253 /* Get and print status from apcupsd NIS server */
254 static int apc_query_server (char *host, int port,
255 struct apc_detail_s *apcups_detail)
256 {
257 int n;
258 char recvline[1024];
259 char *tokptr;
260 char *toksaveptr;
261 char *key;
262 double value;
264 #if APCMAIN
265 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
266 #else
267 # define PRINT_VALUE(name, val) /**/
268 #endif
270 if (global_sockfd < 0)
271 {
272 global_sockfd = net_open (host, port);
273 if (global_sockfd < 0)
274 {
275 ERROR ("apcups plugin: Connecting to the "
276 "apcupsd failed.");
277 return (-1);
278 }
279 }
281 if (net_send (&global_sockfd, "status", 6) < 0)
282 {
283 ERROR ("apcups plugin: Writing to the socket failed.");
284 return (-1);
285 }
287 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
288 {
289 assert ((unsigned int)n < sizeof (recvline));
290 recvline[n] = '\0';
291 #if APCMAIN
292 printf ("net_recv = `%s';\n", recvline);
293 #endif /* if APCMAIN */
295 toksaveptr = NULL;
296 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
297 while (tokptr != NULL)
298 {
299 key = tokptr;
300 if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
301 continue;
302 value = atof (tokptr);
304 PRINT_VALUE (key, value);
306 if (strcmp ("LINEV", key) == 0)
307 apcups_detail->linev = value;
308 else if (strcmp ("BATTV", key) == 0)
309 apcups_detail->battv = value;
310 else if (strcmp ("ITEMP", key) == 0)
311 apcups_detail->itemp = value;
312 else if (strcmp ("LOADPCT", key) == 0)
313 apcups_detail->loadpct = value;
314 else if (strcmp ("BCHARGE", key) == 0)
315 apcups_detail->bcharge = value;
316 else if (strcmp ("OUTPUTV", key) == 0)
317 apcups_detail->outputv = value;
318 else if (strcmp ("LINEFREQ", key) == 0)
319 apcups_detail->linefreq = value;
320 else if (strcmp ("TIMELEFT", key) == 0)
321 apcups_detail->timeleft = value;
323 tokptr = strtok_r (NULL, ":", &toksaveptr);
324 } /* while (tokptr != NULL) */
325 }
327 if (n < 0)
328 {
329 WARNING ("apcups plugin: Error reading from socket");
330 return (-1);
331 }
333 return (0);
334 }
336 static int apcups_config (const char *key, const char *value)
337 {
338 if (strcasecmp (key, "host") == 0)
339 {
340 if (conf_host != NULL)
341 {
342 free (conf_host);
343 conf_host = NULL;
344 }
345 if ((conf_host = strdup (value)) == NULL)
346 return (1);
347 }
348 else if (strcasecmp (key, "Port") == 0)
349 {
350 int port_tmp = atoi (value);
351 if (port_tmp < 1 || port_tmp > 65535)
352 {
353 WARNING ("apcups plugin: Invalid port: %i", port_tmp);
354 return (1);
355 }
356 conf_port = port_tmp;
357 }
358 else
359 {
360 return (-1);
361 }
362 return (0);
363 }
365 static void apc_submit_generic (char *type, char *type_inst, double value)
366 {
367 value_t values[1];
368 value_list_t vl = VALUE_LIST_INIT;
370 values[0].gauge = value;
372 vl.values = values;
373 vl.values_len = 1;
374 vl.time = time (NULL);
375 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
376 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
377 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
378 sstrncpy (vl.type, type, sizeof (vl.type));
379 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
381 plugin_dispatch_values (&vl);
382 }
384 static void apc_submit (struct apc_detail_s *apcups_detail)
385 {
386 apc_submit_generic ("voltage", "input", apcups_detail->linev);
387 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
388 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
389 apc_submit_generic ("charge", "", apcups_detail->bcharge);
390 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
391 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
392 apc_submit_generic ("temperature", "", apcups_detail->itemp);
393 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
394 }
396 static int apcups_read (void)
397 {
398 struct apc_detail_s apcups_detail;
399 int status;
401 apcups_detail.linev = -1.0;
402 apcups_detail.outputv = -1.0;
403 apcups_detail.battv = -1.0;
404 apcups_detail.loadpct = -1.0;
405 apcups_detail.bcharge = -1.0;
406 apcups_detail.timeleft = -1.0;
407 apcups_detail.itemp = -300.0;
408 apcups_detail.linefreq = -1.0;
410 status = apc_query_server (conf_host == NULL
411 ? APCUPS_DEFAULT_HOST
412 : conf_host,
413 conf_port, &apcups_detail);
415 /*
416 * if we did not connect then do not bother submitting
417 * zeros. We want rrd files to have NAN.
418 */
419 if (status != 0)
420 {
421 DEBUG ("apc_query_server (%s, %i) = %i",
422 conf_host == NULL
423 ? APCUPS_DEFAULT_HOST
424 : conf_host,
425 conf_port, status);
426 return (-1);
427 }
429 apc_submit (&apcups_detail);
431 return (0);
432 } /* apcups_read */
434 void module_register (void)
435 {
436 plugin_register_config ("apcups", apcups_config, config_keys,
437 config_keys_num);
438 plugin_register_read ("apcups", apcups_read);
439 plugin_register_shutdown ("apcups", apcups_shutdown);
440 } /* void module_register */