2 * collectd - src/olsrd.c
3 * Copyright (C) 2009 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
32 #include <sys/types.h>
34 #include <netinet/in.h>
35 #include <netinet/tcp.h>
37 #define OLSRD_DEFAULT_NODE "localhost"
38 #define OLSRD_DEFAULT_SERVICE "2006"
40 static const char *config_keys[] =
48 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
50 static char *config_node = NULL;
51 static char *config_service = NULL;
53 #define OLSRD_WANT_NOT 0
54 #define OLSRD_WANT_SUMMARY 1
55 #define OLSRD_WANT_DETAIL 2
56 static int config_want_links = OLSRD_WANT_DETAIL;
57 static int config_want_routes = OLSRD_WANT_SUMMARY;
58 static int config_want_topology = OLSRD_WANT_SUMMARY;
60 static const char *olsrd_get_node (void) /* {{{ */
62 if (config_node != NULL)
64 return (OLSRD_DEFAULT_NODE);
65 } /* }}} const char *olsrd_get_node */
67 static const char *olsrd_get_service (void) /* {{{ */
69 if (config_service != NULL)
70 return (config_service);
71 return (OLSRD_DEFAULT_SERVICE);
72 } /* }}} const char *olsrd_get_service */
74 static void olsrd_set_node (const char *node) /* {{{ */
83 } /* }}} void olsrd_set_node */
85 static void olsrd_set_service (const char *service) /* {{{ */
90 tmp = strdup (service);
94 } /* }}} void olsrd_set_service */
96 static void olsrd_set_detail (int *varptr, const char *detail, /* {{{ */
99 if (strcasecmp ("No", detail) == 0)
100 *varptr = OLSRD_WANT_NOT;
101 else if (strcasecmp ("Summary", detail) == 0)
102 *varptr = OLSRD_WANT_SUMMARY;
103 else if (strcasecmp ("Detail", detail) == 0)
104 *varptr = OLSRD_WANT_DETAIL;
107 ERROR ("olsrd plugin: Invalid argument given to the `%s' configuration "
108 "option: `%s'. Expected: `No', `Summary', or `Detail'.",
111 } /* }}} void olsrd_set_detail */
113 /* Strip trailing newline characters. Returns length of string. */
114 static size_t strchomp (char *buffer) /* {{{ */
118 buffer_len = strlen (buffer);
119 while ((buffer_len > 0)
120 && ((buffer[buffer_len - 1] == '\r')
121 || (buffer[buffer_len - 1] == '\n')))
124 buffer[buffer_len] = 0;
128 } /* }}} size_t strchomp */
130 static size_t strtabsplit (char *string, char **fields, size_t size) /* {{{ */
139 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
149 } /* }}} size_t strtabsplit */
151 static FILE *olsrd_connect (void) /* {{{ */
153 struct addrinfo *ai_list;
158 struct addrinfo ai_hints = {
159 .ai_family = AF_UNSPEC,
160 .ai_flags = AI_ADDRCONFIG,
161 .ai_protocol = IPPROTO_TCP,
162 .ai_socktype = SOCK_STREAM
165 ai_return = getaddrinfo (olsrd_get_node (), olsrd_get_service (),
166 &ai_hints, &ai_list);
169 ERROR ("olsrd plugin: getaddrinfo (%s, %s) failed: %s",
170 olsrd_get_node (), olsrd_get_service (),
171 gai_strerror (ai_return));
176 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
182 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
185 ERROR ("olsrd plugin: socket failed: %s",
186 sstrerror (errno, errbuf, sizeof (errbuf)));
190 status = connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
193 ERROR ("olsrd plugin: connect failed: %s",
194 sstrerror (errno, errbuf, sizeof (errbuf)));
199 fh = fdopen (fd, "r+");
202 ERROR ("olsrd plugin: fdopen failed.");
210 freeaddrinfo (ai_list);
213 } /* }}} FILE *olsrd_connect */
215 __attribute__ ((nonnull(2)))
216 static void olsrd_submit (const char *plugin_instance, /* {{{ */
217 const char *type, const char *type_instance, gauge_t value)
220 value_list_t vl = VALUE_LIST_INIT;
222 values[0].gauge = value;
227 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
228 sstrncpy (vl.plugin, "olsrd", sizeof (vl.plugin));
229 if (plugin_instance != NULL)
230 sstrncpy (vl.plugin_instance, plugin_instance,
231 sizeof (vl.plugin_instance));
232 sstrncpy (vl.type, type, sizeof (vl.type));
233 if (type_instance != NULL)
234 sstrncpy (vl.type_instance, type_instance,
235 sizeof (vl.type_instance));
237 plugin_dispatch_values (&vl);
238 } /* }}} void olsrd_submit */
240 static int olsrd_cb_ignore (int lineno, /* {{{ */
241 size_t fields_num, char **fields)
244 } /* }}} int olsrd_cb_ignore */
246 static int olsrd_cb_links (int lineno, /* {{{ */
247 size_t fields_num, char **fields)
257 static uint32_t links_num;
258 static double lq_sum;
259 static uint32_t lq_num;
260 static double nlq_sum;
261 static uint32_t nlq_num;
268 if (config_want_links == OLSRD_WANT_NOT)
271 /* Special handling of the first line. */
283 /* Special handling of the last line. */
286 DEBUG ("olsrd plugin: Number of links: %"PRIu32, links_num);
287 olsrd_submit (/* p.-inst = */ "links", /* type = */ "links",
288 /* t.-inst = */ NULL, (gauge_t) links_num);
292 lq = lq_sum / ((double) lq_num);
293 DEBUG ("olsrd plugin: Average LQ: %g", lq);
294 olsrd_submit (/* p.-inst = */ "links", /* type = */ "signal_quality",
299 nlq = nlq_sum / ((double) nlq_num);
300 DEBUG ("olsrd plugin: Average NLQ: %g", nlq);
301 olsrd_submit (/* p.-inst = */ "links", /* type = */ "signal_quality",
314 lq = strtod (fields[3], &endptr);
315 if ((errno != 0) || (endptr == fields[3]))
317 ERROR ("olsrd plugin: Cannot parse link quality: %s", fields[3]);
327 if (config_want_links == OLSRD_WANT_DETAIL)
329 char type_instance[DATA_MAX_NAME_LEN];
331 ssnprintf (type_instance, sizeof (type_instance), "%s-%s-lq",
332 fields[0], fields[1]);
334 DEBUG ("olsrd plugin: links: type_instance = %s; lq = %g;",
336 olsrd_submit (/* p.-inst = */ "links", /* type = */ "signal_quality",
343 nlq = strtod (fields[4], &endptr);
344 if ((errno != 0) || (endptr == fields[4]))
346 ERROR ("olsrd plugin: Cannot parse neighbor link quality: %s", fields[4]);
356 if (config_want_links == OLSRD_WANT_DETAIL)
358 char type_instance[DATA_MAX_NAME_LEN];
360 ssnprintf (type_instance, sizeof (type_instance), "%s-%s-rx",
361 fields[0], fields[1]);
363 DEBUG ("olsrd plugin: links: type_instance = %s; nlq = %g;",
365 olsrd_submit (/* p.-inst = */ "links", /* type = */ "signal_quality",
371 } /* }}} int olsrd_cb_links */
373 static int olsrd_cb_routes (int lineno, /* {{{ */
374 size_t fields_num, char **fields)
383 static uint32_t routes_num;
384 static uint32_t metric_sum;
385 static uint32_t metric_num;
386 static double etx_sum;
387 static uint32_t etx_num;
393 if (config_want_routes == OLSRD_WANT_NOT)
396 /* Special handling of the first line */
408 /* Special handling after the last line */
413 DEBUG ("olsrd plugin: Number of routes: %"PRIu32, routes_num);
414 olsrd_submit (/* p.-inst = */ "routes", /* type = */ "routes",
415 /* t.-inst = */ NULL, (gauge_t) routes_num);
419 metric_avg = ((double) metric_sum) / ((double) metric_num);
420 DEBUG ("olsrd plugin: Average metric: %g", metric_avg);
421 olsrd_submit (/* p.-inst = */ "routes", /* type = */ "route_metric",
422 "average", metric_avg);
426 etx = etx_sum / ((double) etx_sum);
427 DEBUG ("olsrd plugin: Average ETX: %g", etx);
428 olsrd_submit (/* p.-inst = */ "routes", /* type = */ "route_etx",
441 metric = (uint32_t) strtoul (fields[2], &endptr, 0);
442 if ((errno != 0) || (endptr == fields[2]))
444 ERROR ("olsrd plugin: Unable to parse metric: %s", fields[2]);
449 metric_sum += metric;
451 if (config_want_routes == OLSRD_WANT_DETAIL)
453 DEBUG ("olsrd plugin: destination = %s; metric = %"PRIu32";",
455 olsrd_submit (/* p.-inst = */ "routes", /* type = */ "route_metric",
456 /* t.-inst = */ fields[0], (gauge_t) metric);
462 etx = strtod (fields[3], &endptr);
463 if ((errno != 0) || (endptr == fields[3]))
465 ERROR ("olsrd plugin: Unable to parse ETX: %s", fields[3]);
475 if (config_want_routes == OLSRD_WANT_DETAIL)
477 DEBUG ("olsrd plugin: destination = %s; etx = %g;",
479 olsrd_submit (/* p.-inst = */ "routes", /* type = */ "route_etx",
480 /* t.-inst = */ fields[0], etx);
485 } /* }}} int olsrd_cb_routes */
487 static int olsrd_cb_topology (int lineno, /* {{{ */
488 size_t fields_num, char **fields)
497 static double lq_sum;
498 static uint32_t lq_num;
500 static uint32_t links_num;
505 if (config_want_topology == OLSRD_WANT_NOT)
508 /* Special handling of the first line */
518 /* Special handling after the last line */
521 DEBUG ("olsrd plugin: topology: Number of links: %"PRIu32, links_num);
522 olsrd_submit (/* p.-inst = */ "topology", /* type = */ "links",
523 /* t.-inst = */ NULL, (gauge_t) links_num);
527 lq = lq_sum / ((double) lq_sum);
528 DEBUG ("olsrd plugin: topology: Average link quality: %g", lq);
529 olsrd_submit (/* p.-inst = */ "topology", /* type = */ "signal_quality",
530 /* t.-inst = */ "average", lq);
542 lq = strtod (fields[2], &endptr);
543 if ((errno != 0) || (endptr == fields[2]))
545 ERROR ("olsrd plugin: Unable to parse LQ: %s", fields[2]);
555 if (config_want_topology == OLSRD_WANT_DETAIL)
557 char type_instance[DATA_MAX_NAME_LEN] = { 0 };
559 ssnprintf (type_instance, sizeof (type_instance), "%s-%s-lq",
560 fields[0], fields[1]);
561 DEBUG ("olsrd plugin: type_instance = %s; lq = %g;", type_instance, lq);
562 olsrd_submit (/* p.-inst = */ "topology", /* type = */ "signal_quality",
567 if (config_want_topology == OLSRD_WANT_DETAIL)
573 nlq = strtod (fields[3], &endptr);
574 if ((errno != 0) || (endptr == fields[3]))
576 ERROR ("olsrd plugin: Unable to parse NLQ: %s", fields[3]);
580 char type_instance[DATA_MAX_NAME_LEN] = { 0 };
582 ssnprintf (type_instance, sizeof (type_instance), "%s-%s-nlq",
583 fields[0], fields[1]);
584 DEBUG ("olsrd plugin: type_instance = %s; nlq = %g;", type_instance, nlq);
585 olsrd_submit (/* p.-inst = */ "topology", /* type = */ "signal_quality",
591 } /* }}} int olsrd_cb_topology */
593 static int olsrd_read_table (FILE *fh, /* {{{ */
594 int (*callback) (int lineno, size_t fields_num, char **fields))
605 while (fgets (buffer, sizeof (buffer), fh) != NULL)
607 /* An empty line ends the table. */
608 buffer_len = strchomp (buffer);
611 (*callback) (lineno, /* fields_num = */ 0, /* fields = */ NULL);
615 fields_num = strtabsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
617 (*callback) (lineno, fields_num, fields);
619 } /* while (fgets) */
622 } /* }}} int olsrd_read_table */
624 static int olsrd_config (const char *key, const char *value) /* {{{ */
626 if (strcasecmp ("Host", key) == 0)
627 olsrd_set_node (value);
628 else if (strcasecmp ("Port", key) == 0)
629 olsrd_set_service (value);
630 else if (strcasecmp ("CollectLinks", key) == 0)
631 olsrd_set_detail (&config_want_links, value, key);
632 else if (strcasecmp ("CollectRoutes", key) == 0)
633 olsrd_set_detail (&config_want_routes, value, key);
634 else if (strcasecmp ("CollectTopology", key) == 0)
635 olsrd_set_detail (&config_want_topology, value, key);
638 ERROR ("olsrd plugin: Unknown configuration option given: %s", key);
643 } /* }}} int olsrd_config */
645 static int olsrd_read (void) /* {{{ */
651 fh = olsrd_connect ();
658 while (fgets (buffer, sizeof (buffer), fh) != NULL)
660 buffer_len = strchomp (buffer);
664 if (strcmp ("Table: Links", buffer) == 0)
665 olsrd_read_table (fh, olsrd_cb_links);
666 else if (strcmp ("Table: Neighbors", buffer) == 0)
667 olsrd_read_table (fh, olsrd_cb_ignore);
668 else if (strcmp ("Table: Topology", buffer) == 0)
669 olsrd_read_table (fh, olsrd_cb_topology);
670 else if (strcmp ("Table: HNA", buffer) == 0)
671 olsrd_read_table (fh, olsrd_cb_ignore);
672 else if (strcmp ("Table: MID", buffer) == 0)
673 olsrd_read_table (fh, olsrd_cb_ignore);
674 else if (strcmp ("Table: Routes", buffer) == 0)
675 olsrd_read_table (fh, olsrd_cb_routes);
676 else if ((strcmp ("HTTP/1.0 200 OK", buffer) == 0)
677 || (strcmp ("Content-type: text/plain", buffer) == 0))
683 DEBUG ("olsrd plugin: Unable to handle line: %s", buffer);
685 } /* while (fgets) */
690 } /* }}} int olsrd_read */
692 static int olsrd_shutdown (void) /* {{{ */
695 sfree (config_service);
698 } /* }}} int olsrd_shutdown */
700 void module_register (void)
702 plugin_register_config ("olsrd", olsrd_config,
703 config_keys, config_keys_num);
704 plugin_register_read ("olsrd", olsrd_read);
705 plugin_register_shutdown ("olsrd", olsrd_shutdown);
706 } /* void module_register */
708 /* vim: set sw=2 sts=2 et fdm=marker : */