Code

Merge branch 'collectd-4.0'
[collectd.git] / src / network.c
1 /**
2  * collectd - src/network.c
3  * Copyright (C) 2005-2007  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  **/
22 #include "collectd.h"
23 #include "plugin.h"
24 #include "common.h"
25 #include "configfile.h"
26 #include "utils_avltree.h"
28 #include "network.h"
30 #if HAVE_PTHREAD_H
31 # include <pthread.h>
32 #endif
33 #if HAVE_SYS_SOCKET_H
34 # include <sys/socket.h>
35 #endif
36 #if HAVE_NETDB_H
37 # include <netdb.h>
38 #endif
39 #if HAVE_NETINET_IN_H
40 # include <netinet/in.h>
41 #endif
42 #if HAVE_ARPA_INET_H
43 # include <arpa/inet.h>
44 #endif
45 #if HAVE_POLL_H
46 # include <poll.h>
47 #endif
49 /* 1500 - 40 - 8  =  Ethernet packet - IPv6 header - UDP header */
50 /* #define BUFF_SIZE 1452 */
52 #ifndef IPV6_ADD_MEMBERSHIP
53 # ifdef IPV6_JOIN_GROUP
54 #  define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
55 # else
56 #  error "Neither IP_ADD_MEMBERSHIP nor IPV6_JOIN_GROUP is defined"
57 # endif
58 #endif /* !IP_ADD_MEMBERSHIP */
60 #define BUFF_SIZE 1024
62 /*
63  * Private data types
64  */
65 typedef struct sockent
66 {
67         int                      fd;
68         struct sockaddr_storage *addr;
69         socklen_t                addrlen;
70         struct sockent          *next;
71 } sockent_t;
73 /*                      1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
74  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
75  * +-------+-----------------------+-------------------------------+
76  * ! Ver.  !                       ! Length                        !
77  * +-------+-----------------------+-------------------------------+
78  */
79 struct part_header_s
80 {
81         uint16_t type;
82         uint16_t length;
83 };
84 typedef struct part_header_s part_header_t;
86 /*                      1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
87  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
88  * +-------------------------------+-------------------------------+
89  * ! Type                          ! Length                        !
90  * +-------------------------------+-------------------------------+
91  * : (Length - 4) Bytes                                            :
92  * +---------------------------------------------------------------+
93  */
94 struct part_string_s
95 {
96         part_header_t *head;
97         char *value;
98 };
99 typedef struct part_string_s part_string_t;
101 /*                      1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
102  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
103  * +-------------------------------+-------------------------------+
104  * ! Type                          ! Length                        !
105  * +-------------------------------+-------------------------------+
106  * : (Length - 4 == 2 || 4 || 8) Bytes                             :
107  * +---------------------------------------------------------------+
108  */
109 struct part_number_s
111         part_header_t *head;
112         uint64_t *value;
113 };
114 typedef struct part_number_s part_number_t;
116 /*                      1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
117  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
118  * +-------------------------------+-------------------------------+
119  * ! Type                          ! Length                        !
120  * +-------------------------------+---------------+---------------+
121  * ! Num of values                 ! Type0         ! Type1         !
122  * +-------------------------------+---------------+---------------+
123  * ! Value0                                                        !
124  * !                                                               !
125  * +---------------------------------------------------------------+
126  * ! Value1                                                        !
127  * !                                                               !
128  * +---------------------------------------------------------------+
129  */
130 struct part_values_s
132         part_header_t *head;
133         uint16_t *num_values;
134         uint8_t  *values_types;
135         value_t  *values;
136 };
137 typedef struct part_values_s part_values_t;
139 /*
140  * Private variables
141  */
142 static const char *config_keys[] =
144         "CacheFlush",
145         "Listen",
146         "Server",
147         "TimeToLive",
148         "Forward"
149 };
150 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
152 static int network_config_ttl = 0;
153 static int network_config_forward = 0;
155 static sockent_t *sending_sockets = NULL;
157 static struct pollfd *listen_sockets = NULL;
158 static int listen_sockets_num = 0;
159 static pthread_t listen_thread = 0;
160 static int listen_loop = 0;
162 static char         send_buffer[BUFF_SIZE];
163 static char        *send_buffer_ptr;
164 static int          send_buffer_fill;
165 static value_list_t send_buffer_vl = VALUE_LIST_STATIC;
166 static char         send_buffer_type[DATA_MAX_NAME_LEN];
167 static pthread_mutex_t send_buffer_lock = PTHREAD_MUTEX_INITIALIZER;
169 static avl_tree_t      *cache_tree = NULL;
170 static pthread_mutex_t  cache_lock = PTHREAD_MUTEX_INITIALIZER;
171 static time_t           cache_flush_last;
172 static int              cache_flush_interval = 1800;
174 /*
175  * Private functions
176  */
177 static int cache_flush (void)
179         char **keys = NULL;
180         int    keys_num = 0;
182         char **tmp;
183         int    i;
185         char   *key;
186         time_t *value;
187         avl_iterator_t *iter;
189         time_t curtime = time (NULL);
191         iter = avl_get_iterator (cache_tree);
192         while (avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
193         {
194                 if ((curtime - *value) <= cache_flush_interval)
195                         continue;
196                 tmp = (char **) realloc (keys,
197                                 (keys_num + 1) * sizeof (char *));
198                 if (tmp == NULL)
199                 {
200                         sfree (keys);
201                         avl_iterator_destroy (iter);
202                         ERROR ("network plugin: cache_flush: realloc"
203                                         " failed.");
204                         return (-1);
205                 }
206                 keys = tmp;
207                 keys[keys_num] = key;
208                 keys_num++;
209         } /* while (avl_iterator_next) */
210         avl_iterator_destroy (iter);
212         for (i = 0; i < keys_num; i++)
213         {
214                 if (avl_remove (cache_tree, keys[i], (void *) &key,
215                                         (void *) &value) != 0)
216                 {
217                         WARNING ("network plugin: cache_flush: avl_remove"
218                                         " (%s) failed.", keys[i]);
219                         continue;
220                 }
222                 sfree (key);
223                 sfree (value);
224         }
226         sfree (keys);
228         DEBUG ("network plugin: cache_flush: Removed %i %s",
229                         keys_num, (keys_num == 1) ? "entry" : "entries");
230         cache_flush_last = curtime;
231         return (0);
232 } /* int cache_flush */
234 static int cache_check (const char *type, const value_list_t *vl)
236         char key[1024];
237         time_t *value = NULL;
238         int retval = -1;
240         if (cache_tree == NULL)
241                 return (-1);
243         if (format_name (key, sizeof (key), vl->host, vl->plugin,
244                                 vl->plugin_instance, type, vl->type_instance))
245                 return (-1);
247         pthread_mutex_lock (&cache_lock);
249         if (avl_get (cache_tree, key, (void *) &value) == 0)
250         {
251                 if (*value < vl->time)
252                 {
253                         *value = vl->time;
254                         retval = 0;
255                 }
256                 else
257                 {
258                         DEBUG ("network plugin: cache_check: *value = %i >= vl->time = %i",
259                                         (int) *value, (int) vl->time);
260                         retval = 1;
261                 }
262         }
263         else
264         {
265                 char *key_copy = strdup (key);
266                 value = malloc (sizeof (time_t));
267                 if ((key_copy != NULL) && (value != NULL))
268                 {
269                         *value = vl->time;
270                         avl_insert (cache_tree, key_copy, value);
271                         retval = 0;
272                 }
273                 else
274                 {
275                         sfree (key_copy);
276                         sfree (value);
277                 }
278         }
280         if ((time (NULL) - cache_flush_last) > cache_flush_interval)
281                 cache_flush ();
283         pthread_mutex_unlock (&cache_lock);
285         DEBUG ("network plugin: cache_check: key = %s; time = %i; retval = %i",
286                         key, (int) vl->time, retval);
288         return (retval);
289 } /* int cache_check */
291 static int write_part_values (char **ret_buffer, int *ret_buffer_len,
292                 const data_set_t *ds, const value_list_t *vl)
294         part_values_t pv;
295         int i;
297         i = 6 + (9 * vl->values_len);
298         if (*ret_buffer_len < i)
299                 return (-1);
300         *ret_buffer_len -= i;
302         pv.head = (part_header_t *) *ret_buffer;
303         pv.num_values = (uint16_t *) (pv.head + 1);
304         pv.values_types = (uint8_t *) (pv.num_values + 1);
305         pv.values = (value_t *) (pv.values_types + vl->values_len);
306         *ret_buffer = (void *) (pv.values + vl->values_len);
308         pv.head->type = htons (TYPE_VALUES);
309         pv.head->length = htons (6 + (9 * vl->values_len));
310         *pv.num_values = htons ((uint16_t) vl->values_len);
311         
312         for (i = 0; i < vl->values_len; i++)
313         {
314                 if (ds->ds[i].type == DS_TYPE_COUNTER)
315                 {
316                         pv.values_types[i] = DS_TYPE_COUNTER;
317                         pv.values[i].counter = htonll (vl->values[i].counter);
318                 }
319                 else
320                 {
321                         pv.values_types[i] = DS_TYPE_GAUGE;
322                         pv.values[i].gauge = vl->values[i].gauge;
323                 }
324         } /* for (values) */
326         return (0);
327 } /* int write_part_values */
329 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
330                 int type, uint64_t value)
332         part_number_t pn;
334         if (*ret_buffer_len < 12)
335                 return (-1);
337         pn.head = (part_header_t *) *ret_buffer;
338         pn.value = (uint64_t *) (pn.head + 1);
340         pn.head->type = htons (type);
341         pn.head->length = htons (12);
342         *pn.value = htonll (value);
344         *ret_buffer = (char *) (pn.value + 1);
345         *ret_buffer_len -= 12;
347         return (0);
348 } /* int write_part_number */
350 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
351                 int type, const char *str, int str_len)
353         part_string_t ps;
354         int len;
356         len = 4 + str_len + 1;
357         if (*ret_buffer_len < len)
358                 return (-1);
359         *ret_buffer_len -= len;
361         ps.head = (part_header_t *) *ret_buffer;
362         ps.value = (char *) (ps.head + 1);
364         ps.head->type = htons ((uint16_t) type);
365         ps.head->length = htons ((uint16_t) str_len + 5);
366         if (str_len > 0)
367                 memcpy (ps.value, str, str_len);
368         ps.value[str_len] = '\0';
369         *ret_buffer = (void *) (ps.value + (str_len + 1));
371         return (0);
372 } /* int write_part_string */
374 static int parse_part_values (void **ret_buffer, int *ret_buffer_len,
375                 value_t **ret_values, int *ret_num_values)
377         char *buffer = *ret_buffer;
378         int   buffer_len = *ret_buffer_len;
379         part_values_t pv;
380         int   i;
382         uint16_t h_length;
383         uint16_t h_type;
384         uint16_t h_num;
386         if (buffer_len < (15))
387         {
388                 DEBUG ("network plugin: packet is too short: buffer_len = %i",
389                                 buffer_len);
390                 return (-1);
391         }
393         pv.head = (part_header_t *) buffer;
394         h_length = ntohs (pv.head->length);
395         h_type = ntohs (pv.head->type);
397         assert (h_type == TYPE_VALUES);
399         pv.num_values = (uint16_t *) (pv.head + 1);
400         h_num = ntohs (*pv.num_values);
402         if (h_num != ((h_length - 6) / 9))
403         {
404                 DEBUG ("`length' and `num of values' don't match");
405                 return (-1);
406         }
408         pv.values_types = (uint8_t *) (pv.num_values + 1);
409         pv.values = (value_t *) (pv.values_types + h_num);
411         for (i = 0; i < h_num; i++)
412                 if (pv.values_types[i] == DS_TYPE_COUNTER)
413                         pv.values[i].counter = ntohll (pv.values[i].counter);
415         *ret_buffer     = (void *) (pv.values + h_num);
416         *ret_buffer_len = buffer_len - h_length;
417         *ret_num_values = h_num;
418         *ret_values     = pv.values;
420         return (0);
421 } /* int parse_part_values */
423 static int parse_part_number (void **ret_buffer, int *ret_buffer_len,
424                 uint64_t *value)
426         part_number_t pn;
427         uint16_t len;
429         pn.head = (part_header_t *) *ret_buffer;
430         pn.value = (uint64_t *) (pn.head + 1);
432         len = ntohs (pn.head->length);
433         if (len != 12)
434                 return (-1);
435         if (len > *ret_buffer_len)
436                 return (-1);
437         *value = ntohll (*pn.value);
439         *ret_buffer = (void *) (pn.value + 1);
440         *ret_buffer_len -= len;
442         return (0);
443 } /* int parse_part_number */
445 static int parse_part_string (void **ret_buffer, int *ret_buffer_len,
446                 char *output, int output_len)
448         char *buffer = *ret_buffer;
449         int   buffer_len = *ret_buffer_len;
450         part_string_t ps;
452         uint16_t h_length;
453         uint16_t h_type;
455         DEBUG ("network plugin: parse_part_string: ret_buffer = %p;"
456                         " ret_buffer_len = %i; output = %p; output_len = %i;",
457                         *ret_buffer, *ret_buffer_len,
458                         (void *) output, output_len);
460         ps.head = (part_header_t *) buffer;
462         h_length = ntohs (ps.head->length);
463         h_type = ntohs (ps.head->type);
465         DEBUG ("network plugin: parse_part_string: length = %hu; type = %hu;",
466                         h_length, h_type);
468         if (buffer_len < h_length)
469         {
470                 DEBUG ("packet is too short");
471                 return (-1);
472         }
473         assert ((h_type == TYPE_HOST)
474                         || (h_type == TYPE_PLUGIN)
475                         || (h_type == TYPE_PLUGIN_INSTANCE)
476                         || (h_type == TYPE_TYPE)
477                         || (h_type == TYPE_TYPE_INSTANCE));
479         ps.value = buffer + 4;
480         if (ps.value[h_length - 5] != '\0')
481         {
482                 DEBUG ("String does not end with a nullbyte");
483                 return (-1);
484         }
486         if (output_len < (h_length - 4))
487         {
488                 DEBUG ("output buffer is too small");
489                 return (-1);
490         }
491         strcpy (output, ps.value);
493         DEBUG ("network plugin: parse_part_string: output = %s", output);
495         *ret_buffer = (void *) (buffer + h_length);
496         *ret_buffer_len = buffer_len - h_length;
498         return (0);
499 } /* int parse_part_string */
501 static int parse_packet (void *buffer, int buffer_len)
503         part_header_t *header;
504         int status;
506         value_list_t vl = VALUE_LIST_INIT;
507         char type[DATA_MAX_NAME_LEN];
509         DEBUG ("network plugin: parse_packet: buffer = %p; buffer_len = %i;",
510                         buffer, buffer_len);
512         memset (&vl, '\0', sizeof (vl));
513         memset (&type, '\0', sizeof (type));
514         status = 0;
516         while ((status == 0) && (buffer_len > sizeof (part_header_t)))
517         {
518                 header = (part_header_t *) buffer;
520                 if (ntohs (header->length) > buffer_len)
521                         break;
522                 /* Assure that this loop terminates eventually */
523                 if (ntohs (header->length) < 4)
524                         break;
526                 if (ntohs (header->type) == TYPE_VALUES)
527                 {
528                         status = parse_part_values (&buffer, &buffer_len,
529                                         &vl.values, &vl.values_len);
531                         if (status != 0)
532                         {
533                                 DEBUG ("parse_part_values failed.");
534                                 break;
535                         }
537                         if ((vl.time > 0)
538                                         && (strlen (vl.host) > 0)
539                                         && (strlen (vl.plugin) > 0)
540                                         && (strlen (type) > 0)
541                                         && (cache_check (type, &vl) == 0))
542                         {
543                                 DEBUG ("network plugin: parse_packet:"
544                                                 " dispatching values");
545                                 plugin_dispatch_values (type, &vl);
546                         }
547                         else
548                         {
549                                 DEBUG ("network plugin: parse_packet:"
550                                                 " NOT dispatching values");
551                         }
552                 }
553                 else if (ntohs (header->type) == TYPE_TIME)
554                 {
555                         uint64_t tmp = 0;
556                         status = parse_part_number (&buffer, &buffer_len, &tmp);
557                         if (status == 0)
558                                 vl.time = (time_t) tmp;
559                 }
560                 else if (ntohs (header->type) == TYPE_INTERVAL)
561                 {
562                         uint64_t tmp = 0;
563                         status = parse_part_number (&buffer, &buffer_len, &tmp);
564                         if (status == 0)
565                                 vl.interval = (int) tmp;
566                 }
567                 else if (ntohs (header->type) == TYPE_HOST)
568                 {
569                         status = parse_part_string (&buffer, &buffer_len,
570                                         vl.host, sizeof (vl.host));
571                         DEBUG ("network plugin: parse_packet: vl.host = %s", vl.host);
572                 }
573                 else if (ntohs (header->type) == TYPE_PLUGIN)
574                 {
575                         status = parse_part_string (&buffer, &buffer_len,
576                                         vl.plugin, sizeof (vl.plugin));
577                         DEBUG ("network plugin: parse_packet: vl.plugin = %s", vl.plugin);
578                 }
579                 else if (ntohs (header->type) == TYPE_PLUGIN_INSTANCE)
580                 {
581                         status = parse_part_string (&buffer, &buffer_len,
582                                         vl.plugin_instance, sizeof (vl.plugin_instance));
583                         DEBUG ("network plugin: parse_packet: vl.plugin_instance = %s", vl.plugin_instance);
584                 }
585                 else if (ntohs (header->type) == TYPE_TYPE)
586                 {
587                         status = parse_part_string (&buffer, &buffer_len,
588                                         type, sizeof (type));
589                         DEBUG ("network plugin: parse_packet: type = %s", type);
590                 }
591                 else if (ntohs (header->type) == TYPE_TYPE_INSTANCE)
592                 {
593                         status = parse_part_string (&buffer, &buffer_len,
594                                         vl.type_instance, sizeof (vl.type_instance));
595                         DEBUG ("network plugin: parse_packet: vl.type_instance = %s", vl.type_instance);
596                 }
597                 else
598                 {
599                         DEBUG ("network plugin: parse_packet: Unknown part"
600                                         " type: 0x%0hx", ntohs (header->type));
601                         buffer = ((char *) buffer) + ntohs (header->length);
602                 }
603         } /* while (buffer_len > sizeof (part_header_t)) */
605         return (0);
606 } /* int parse_packet */
608 static void free_sockent (sockent_t *se)
610         sockent_t *next;
611         while (se != NULL)
612         {
613                 next = se->next;
614                 free (se->addr);
615                 free (se);
616                 se = next;
617         }
618 } /* void free_sockent */
620 /*
621  * int network_set_ttl
622  *
623  * Set the `IP_MULTICAST_TTL', `IP_TTL', `IPV6_MULTICAST_HOPS' or
624  * `IPV6_UNICAST_HOPS', depending on which option is applicable.
625  *
626  * The `struct addrinfo' is used to destinguish between unicast and multicast
627  * sockets.
628  */
629 static int network_set_ttl (const sockent_t *se, const struct addrinfo *ai)
631         if ((network_config_ttl < 1) || (network_config_ttl > 255))
632                 return (-1);
634         DEBUG ("ttl = %i", network_config_ttl);
636         if (ai->ai_family == AF_INET)
637         {
638                 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
639                 int optname;
641                 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
642                         optname = IP_MULTICAST_TTL;
643                 else
644                         optname = IP_TTL;
646                 if (setsockopt (se->fd, IPPROTO_IP, optname,
647                                         &network_config_ttl,
648                                         sizeof (network_config_ttl)) == -1)
649                 {
650                         char errbuf[1024];
651                         ERROR ("setsockopt: %s",
652                                         sstrerror (errno, errbuf, sizeof (errbuf)));
653                         return (-1);
654                 }
655         }
656         else if (ai->ai_family == AF_INET6)
657         {
658                 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
659                 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
660                 int optname;
662                 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
663                         optname = IPV6_MULTICAST_HOPS;
664                 else
665                         optname = IPV6_UNICAST_HOPS;
667                 if (setsockopt (se->fd, IPPROTO_IPV6, optname,
668                                         &network_config_ttl,
669                                         sizeof (network_config_ttl)) == -1)
670                 {
671                         char errbuf[1024];
672                         ERROR ("setsockopt: %s",
673                                         sstrerror (errno, errbuf,
674                                                 sizeof (errbuf)));
675                         return (-1);
676                 }
677         }
679         return (0);
680 } /* int network_set_ttl */
682 static int network_bind_socket (const sockent_t *se, const struct addrinfo *ai)
684         int loop = 0;
686         DEBUG ("fd = %i; calling `bind'", se->fd);
688         if (bind (se->fd, ai->ai_addr, ai->ai_addrlen) == -1)
689         {
690                 char errbuf[1024];
691                 ERROR ("bind: %s",
692                                 sstrerror (errno, errbuf, sizeof (errbuf)));
693                 return (-1);
694         }
696         if (ai->ai_family == AF_INET)
697         {
698                 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
699                 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
700                 {
701                         struct ip_mreq mreq;
703                         DEBUG ("fd = %i; IPv4 multicast address found", se->fd);
705                         mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
706                         mreq.imr_interface.s_addr = htonl (INADDR_ANY);
708                         if (setsockopt (se->fd, IPPROTO_IP, IP_MULTICAST_LOOP,
709                                                 &loop, sizeof (loop)) == -1)
710                         {
711                                 char errbuf[1024];
712                                 ERROR ("setsockopt: %s",
713                                                 sstrerror (errno, errbuf,
714                                                         sizeof (errbuf)));
715                                 return (-1);
716                         }
718                         if (setsockopt (se->fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
719                                                 &mreq, sizeof (mreq)) == -1)
720                         {
721                                 char errbuf[1024];
722                                 ERROR ("setsockopt: %s",
723                                                 sstrerror (errno, errbuf,
724                                                         sizeof (errbuf)));
725                                 return (-1);
726                         }
727                 }
728         }
729         else if (ai->ai_family == AF_INET6)
730         {
731                 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
732                 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
733                 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
734                 {
735                         struct ipv6_mreq mreq;
737                         DEBUG ("fd = %i; IPv6 multicast address found", se->fd);
739                         memcpy (&mreq.ipv6mr_multiaddr,
740                                         &addr->sin6_addr,
741                                         sizeof (addr->sin6_addr));
743                         /* http://developer.apple.com/documentation/Darwin/Reference/ManPages/man4/ip6.4.html
744                          * ipv6mr_interface may be set to zeroes to
745                          * choose the default multicast interface or to
746                          * the index of a particular multicast-capable
747                          * interface if the host is multihomed.
748                          * Membership is associ-associated with a
749                          * single interface; programs running on
750                          * multihomed hosts may need to join the same
751                          * group on more than one interface.*/
752                         mreq.ipv6mr_interface = 0;
754                         if (setsockopt (se->fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
755                                                 &loop, sizeof (loop)) == -1)
756                         {
757                                 char errbuf[1024];
758                                 ERROR ("setsockopt: %s",
759                                                 sstrerror (errno, errbuf,
760                                                         sizeof (errbuf)));
761                                 return (-1);
762                         }
764                         if (setsockopt (se->fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
765                                                 &mreq, sizeof (mreq)) == -1)
766                         {
767                                 char errbuf[1024];
768                                 ERROR ("setsockopt: %s",
769                                                 sstrerror (errno, errbuf,
770                                                         sizeof (errbuf)));
771                                 return (-1);
772                         }
773                 }
774         }
776         return (0);
777 } /* int network_bind_socket */
779 static sockent_t *network_create_socket (const char *node,
780                 const char *service,
781                 int listen)
783         struct addrinfo  ai_hints;
784         struct addrinfo *ai_list, *ai_ptr;
785         int              ai_return;
787         sockent_t *se_head = NULL;
788         sockent_t *se_tail = NULL;
790         DEBUG ("node = %s, service = %s", node, service);
792         memset (&ai_hints, '\0', sizeof (ai_hints));
793         ai_hints.ai_flags    = 0;
794 #ifdef AI_PASSIVE
795         ai_hints.ai_flags |= AI_PASSIVE;
796 #endif
797 #ifdef AI_ADDRCONFIG
798         ai_hints.ai_flags |= AI_ADDRCONFIG;
799 #endif
800         ai_hints.ai_family   = AF_UNSPEC;
801         ai_hints.ai_socktype = SOCK_DGRAM;
802         ai_hints.ai_protocol = IPPROTO_UDP;
804         ai_return = getaddrinfo (node, service, &ai_hints, &ai_list);
805         if (ai_return != 0)
806         {
807                 char errbuf[1024];
808                 ERROR ("getaddrinfo (%s, %s): %s",
809                                 (node == NULL) ? "(null)" : node,
810                                 (service == NULL) ? "(null)" : service,
811                                 (ai_return == EAI_SYSTEM)
812                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
813                                 : gai_strerror (ai_return));
814                 return (NULL);
815         }
817         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
818         {
819                 sockent_t *se;
821                 if ((se = (sockent_t *) malloc (sizeof (sockent_t))) == NULL)
822                 {
823                         char errbuf[1024];
824                         ERROR ("malloc: %s",
825                                         sstrerror (errno, errbuf,
826                                                 sizeof (errbuf)));
827                         continue;
828                 }
830                 if ((se->addr = (struct sockaddr_storage *) malloc (sizeof (struct sockaddr_storage))) == NULL)
831                 {
832                         char errbuf[1024];
833                         ERROR ("malloc: %s",
834                                         sstrerror (errno, errbuf,
835                                                 sizeof (errbuf)));
836                         free (se);
837                         continue;
838                 }
840                 assert (sizeof (struct sockaddr_storage) >= ai_ptr->ai_addrlen);
841                 memset (se->addr, '\0', sizeof (struct sockaddr_storage));
842                 memcpy (se->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
843                 se->addrlen = ai_ptr->ai_addrlen;
845                 se->fd   = socket (ai_ptr->ai_family,
846                                 ai_ptr->ai_socktype,
847                                 ai_ptr->ai_protocol);
848                 se->next = NULL;
850                 if (se->fd == -1)
851                 {
852                         char errbuf[1024];
853                         ERROR ("socket: %s",
854                                         sstrerror (errno, errbuf,
855                                                 sizeof (errbuf)));
856                         free (se->addr);
857                         free (se);
858                         continue;
859                 }
861                 if (listen != 0)
862                 {
863                         if (network_bind_socket (se, ai_ptr) != 0)
864                         {
865                                 close (se->fd);
866                                 free (se->addr);
867                                 free (se);
868                                 continue;
869                         }
870                 }
871                 else /* listen == 0 */
872                 {
873                         network_set_ttl (se, ai_ptr);
874                 }
876                 if (se_tail == NULL)
877                 {
878                         se_head = se;
879                         se_tail = se;
880                 }
881                 else
882                 {
883                         se_tail->next = se;
884                         se_tail = se;
885                 }
887                 /* We don't open more than one write-socket per node/service pair.. */
888                 if (listen == 0)
889                         break;
890         }
892         freeaddrinfo (ai_list);
894         return (se_head);
895 } /* sockent_t *network_create_socket */
897 static sockent_t *network_create_default_socket (int listen)
899         sockent_t *se_ptr  = NULL;
900         sockent_t *se_head = NULL;
901         sockent_t *se_tail = NULL;
903         se_ptr = network_create_socket (NET_DEFAULT_V6_ADDR,
904                         NET_DEFAULT_PORT, listen);
906         /* Don't send to the same machine in IPv6 and IPv4 if both are available. */
907         if ((listen == 0) && (se_ptr != NULL))
908                 return (se_ptr);
910         if (se_ptr != NULL)
911         {
912                 se_head = se_ptr;
913                 se_tail = se_ptr;
914                 while (se_tail->next != NULL)
915                         se_tail = se_tail->next;
916         }
918         se_ptr = network_create_socket (NET_DEFAULT_V4_ADDR, NET_DEFAULT_PORT, listen);
920         if (se_tail == NULL)
921                 return (se_ptr);
923         se_tail->next = se_ptr;
924         return (se_head);
925 } /* sockent_t *network_create_default_socket */
927 static int network_add_listen_socket (const char *node, const char *service)
929         sockent_t *se;
930         sockent_t *se_ptr;
931         int se_num = 0;
933         if (service == NULL)
934                 service = NET_DEFAULT_PORT;
936         if (node == NULL)
937                 se = network_create_default_socket (1 /* listen == true */);
938         else
939                 se = network_create_socket (node, service, 1 /* listen == true */);
941         if (se == NULL)
942                 return (-1);
944         for (se_ptr = se; se_ptr != NULL; se_ptr = se_ptr->next)
945                 se_num++;
947         listen_sockets = (struct pollfd *) realloc (listen_sockets,
948                         (listen_sockets_num + se_num)
949                         * sizeof (struct pollfd));
951         for (se_ptr = se; se_ptr != NULL; se_ptr = se_ptr->next)
952         {
953                 listen_sockets[listen_sockets_num].fd = se_ptr->fd;
954                 listen_sockets[listen_sockets_num].events = POLLIN | POLLPRI;
955                 listen_sockets[listen_sockets_num].revents = 0;
956                 listen_sockets_num++;
957         } /* for (se) */
959         free_sockent (se);
960         return (0);
961 } /* int network_add_listen_socket */
963 static int network_add_sending_socket (const char *node, const char *service)
965         sockent_t *se;
966         sockent_t *se_ptr;
968         if (service == NULL)
969                 service = NET_DEFAULT_PORT;
971         if (node == NULL)
972                 se = network_create_default_socket (0 /* listen == false */);
973         else
974                 se = network_create_socket (node, service, 0 /* listen == false */);
976         if (se == NULL)
977                 return (-1);
979         if (sending_sockets == NULL)
980         {
981                 sending_sockets = se;
982                 return (0);
983         }
985         for (se_ptr = sending_sockets; se_ptr->next != NULL; se_ptr = se_ptr->next)
986                 /* seek end */;
988         se_ptr->next = se;
989         return (0);
990 } /* int network_get_listen_socket */
992 int network_receive (void)
994         char buffer[BUFF_SIZE];
995         int  buffer_len;
997         int i;
998         int status;
1000         if (listen_sockets_num == 0)
1001                 network_add_listen_socket (NULL, NULL);
1003         if (listen_sockets_num == 0)
1004         {
1005                 ERROR ("network: Failed to open a listening socket.");
1006                 return (-1);
1007         }
1009         while (listen_loop == 0)
1010         {
1011                 status = poll (listen_sockets, listen_sockets_num, -1);
1013                 if (status <= 0)
1014                 {
1015                         char errbuf[1024];
1016                         if (errno == EINTR)
1017                                 continue;
1018                         ERROR ("poll failed: %s",
1019                                         sstrerror (errno, errbuf, sizeof (errbuf)));
1020                         return (-1);
1021                 }
1023                 for (i = 0; (i < listen_sockets_num) && (status > 0); i++)
1024                 {
1025                         if ((listen_sockets[i].revents & (POLLIN | POLLPRI)) == 0)
1026                                 continue;
1027                         status--;
1029                         buffer_len = recv (listen_sockets[i].fd,
1030                                         buffer, sizeof (buffer),
1031                                         0 /* no flags */);
1032                         if (buffer_len < 0)
1033                         {
1034                                 char errbuf[1024];
1035                                 ERROR ("recv failed: %s",
1036                                                 sstrerror (errno, errbuf,
1037                                                         sizeof (errbuf)));
1038                                 return (-1);
1039                         }
1041                         parse_packet (buffer, buffer_len);
1042                 } /* for (listen_sockets) */
1043         } /* while (listen_loop == 0) */
1045         return (0);
1048 static void *receive_thread (void *arg)
1050         return (network_receive () ? (void *) 1 : (void *) 0);
1051 } /* void *receive_thread */
1053 static void network_send_buffer (const char *buffer, int buffer_len)
1055         sockent_t *se;
1056         int status;
1058         DEBUG ("network plugin: network_send_buffer: buffer_len = %i", buffer_len);
1060         for (se = sending_sockets; se != NULL; se = se->next)
1061         {
1062                 while (42)
1063                 {
1064                         status = sendto (se->fd, buffer, buffer_len, 0 /* no flags */,
1065                                         (struct sockaddr *) se->addr, se->addrlen);
1066                         if (status < 0)
1067                         {
1068                                 char errbuf[1024];
1069                                 if (errno == EINTR)
1070                                         continue;
1071                                 ERROR ("network plugin: sendto failed: %s",
1072                                                 sstrerror (errno, errbuf,
1073                                                         sizeof (errbuf)));
1074                                 break;
1075                         }
1077                         break;
1078                 } /* while (42) */
1079         } /* for (sending_sockets) */
1080 } /* void network_send_buffer */
1082 static int add_to_buffer (char *buffer, int buffer_size,
1083                 value_list_t *vl_def, char *type_def,
1084                 const data_set_t *ds, const value_list_t *vl)
1086         char *buffer_orig = buffer;
1088         if (strcmp (vl_def->host, vl->host) != 0)
1089         {
1090                 if (write_part_string (&buffer, &buffer_size, TYPE_HOST,
1091                                         vl->host, strlen (vl->host)) != 0)
1092                         return (-1);
1093                 strcpy (vl_def->host, vl->host);
1094                 DEBUG ("network plugin: add_to_buffer: host = %s", vl->host);
1095         }
1097         if (vl_def->time != vl->time)
1098         {
1099                 if (write_part_number (&buffer, &buffer_size, TYPE_TIME,
1100                                         (uint64_t) vl->time))
1101                         return (-1);
1102                 vl_def->time = vl->time;
1103                 DEBUG ("network plugin: add_to_buffer: time = %u",
1104                                 (unsigned int) vl->time);
1105         }
1107         if (vl_def->interval != vl->interval)
1108         {
1109                 if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL,
1110                                         (uint64_t) vl->interval))
1111                         return (-1);
1112                 vl_def->interval = vl->interval;
1113                 DEBUG ("network plugin: add_to_buffer: interval = %i",
1114                                 (int) vl->interval);
1115         }
1117         if (strcmp (vl_def->plugin, vl->plugin) != 0)
1118         {
1119                 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN,
1120                                         vl->plugin, strlen (vl->plugin)) != 0)
1121                         return (-1);
1122                 strcpy (vl_def->plugin, vl->plugin);
1123                 DEBUG ("network plugin: add_to_buffer: plugin = %s",
1124                                 vl->plugin);
1125         }
1127         if (strcmp (vl_def->plugin_instance, vl->plugin_instance) != 0)
1128         {
1129                 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
1130                                         vl->plugin_instance,
1131                                         strlen (vl->plugin_instance)) != 0)
1132                         return (-1);
1133                 strcpy (vl_def->plugin_instance, vl->plugin_instance);
1134                 DEBUG ("network plugin: add_to_buffer: plugin_instance = %s",
1135                                 vl->plugin_instance);
1136         }
1138         if (strcmp (type_def, ds->type) != 0)
1139         {
1140                 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE,
1141                                         ds->type, strlen (ds->type)) != 0)
1142                         return (-1);
1143                 strcpy (type_def, ds->type);
1144                 DEBUG ("network plugin: add_to_buffer: type = %s", ds->type);
1145         }
1147         if (strcmp (vl_def->type_instance, vl->type_instance) != 0)
1148         {
1149                 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
1150                                         vl->type_instance,
1151                                         strlen (vl->type_instance)) != 0)
1152                         return (-1);
1153                 strcpy (vl_def->type_instance, vl->type_instance);
1154                 DEBUG ("network plugin: add_to_buffer: type_instance = %s",
1155                                 vl->type_instance);
1156         }
1157         
1158         if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
1159                 return (-1);
1161         return (buffer - buffer_orig);
1162 } /* int add_to_buffer */
1164 static void flush_buffer (void)
1166         DEBUG ("network plugin: flush_buffer: send_buffer_fill = %i",
1167                         send_buffer_fill);
1169         network_send_buffer (send_buffer, send_buffer_fill);
1170         send_buffer_ptr  = send_buffer;
1171         send_buffer_fill = 0;
1172         memset (&send_buffer_vl, '\0', sizeof (send_buffer_vl));
1173         memset (send_buffer_type, '\0', sizeof (send_buffer_type));
1176 static int network_write (const data_set_t *ds, const value_list_t *vl)
1178         int status;
1180         /* If the value is already in the cache, we have received it via the
1181          * network. We write it again if forwarding is activated. It's then in
1182          * the cache and should we receive it again we will ignore it. */
1183         status = cache_check (ds->type, vl);
1184         if ((network_config_forward == 0)
1185                         && (status != 0))
1186                 return (0);
1188         pthread_mutex_lock (&send_buffer_lock);
1190         status = add_to_buffer (send_buffer_ptr,
1191                         sizeof (send_buffer) - send_buffer_fill,
1192                         &send_buffer_vl, send_buffer_type,
1193                         ds, vl);
1194         if (status >= 0)
1195         {
1196                 /* status == bytes added to the buffer */
1197                 send_buffer_fill += status;
1198                 send_buffer_ptr  += status;
1199         }
1200         else
1201         {
1202                 flush_buffer ();
1204                 status = add_to_buffer (send_buffer_ptr,
1205                                 sizeof (send_buffer) - send_buffer_fill,
1206                                 &send_buffer_vl, send_buffer_type,
1207                                 ds, vl);
1209                 if (status >= 0)
1210                 {
1211                         send_buffer_fill += status;
1212                         send_buffer_ptr  += status;
1213                 }
1214         }
1216         if (status < 0)
1217         {
1218                 ERROR ("network plugin: Unable to append to the "
1219                                 "buffer for some weird reason");
1220         }
1221         else if ((sizeof (send_buffer) - send_buffer_fill) < 15)
1222         {
1223                 flush_buffer ();
1224         }
1226         pthread_mutex_unlock (&send_buffer_lock);
1228         return ((status < 0) ? -1 : 0);
1229 } /* int network_write */
1231 static int network_config (const char *key, const char *val)
1233         char *node;
1234         char *service;
1236         char *fields[3];
1237         int   fields_num;
1239         if ((strcasecmp ("Listen", key) == 0)
1240                         || (strcasecmp ("Server", key) == 0))
1241         {
1242                 char *val_cpy = strdup (val);
1243                 if (val_cpy == NULL)
1244                         return (1);
1246                 service = NET_DEFAULT_PORT;
1247                 fields_num = strsplit (val_cpy, fields, 3);
1248                 if ((fields_num != 1)
1249                                 && (fields_num != 2))
1250                         return (1);
1251                 else if (fields_num == 2)
1252                         service = fields[1];
1253                 node = fields[0];
1255                 if (strcasecmp ("Listen", key) == 0)
1256                         network_add_listen_socket (node, service);
1257                 else
1258                         network_add_sending_socket (node, service);
1259         }
1260         else if (strcasecmp ("TimeToLive", key) == 0)
1261         {
1262                 int tmp = atoi (val);
1263                 if ((tmp > 0) && (tmp < 256))
1264                         network_config_ttl = tmp;
1265                 else
1266                         return (1);
1267         }
1268         else if (strcasecmp ("Forward", key) == 0)
1269         {
1270                 if ((strcasecmp ("true", val) == 0)
1271                                 || (strcasecmp ("yes", val) == 0)
1272                                 || (strcasecmp ("on", val) == 0))
1273                         network_config_forward = 1;
1274                 else
1275                         network_config_forward = 0;
1276         }
1277         else if (strcasecmp ("CacheFlush", key) == 0)
1278         {
1279                 int tmp = atoi (val);
1280                 if (tmp > 0)
1281                         cache_flush_interval = tmp;
1282                 else return (1);
1283         }
1284         else
1285         {
1286                 return (-1);
1287         }
1288         return (0);
1289 } /* int network_config */
1291 static int network_shutdown (void)
1293         DEBUG ("Shutting down.");
1295         listen_loop++;
1297         if (listen_thread != (pthread_t) 0)
1298         {
1299                 pthread_kill (listen_thread, SIGTERM);
1300                 pthread_join (listen_thread, NULL /* no return value */);
1301                 listen_thread = (pthread_t) 0;
1302         }
1304         listen_thread = 0;
1306         if (cache_tree != NULL)
1307         {
1308                 void *key;
1309                 void *value;
1311                 while (avl_pick (cache_tree, &key, &value) == 0)
1312                 {
1313                         sfree (key);
1314                         sfree (value);
1315                 }
1316                 avl_destroy (cache_tree);
1317                 cache_tree = NULL;
1318         }
1320         /* TODO: Close `sending_sockets' */
1322         plugin_unregister_config ("network");
1323         plugin_unregister_init ("network");
1324         plugin_unregister_write ("network");
1325         plugin_unregister_shutdown ("network");
1327         return (0);
1328 } /* int network_shutdown */
1330 static int network_init (void)
1332         plugin_register_shutdown ("network", network_shutdown);
1334         send_buffer_ptr  = send_buffer;
1335         send_buffer_fill = 0;
1336         memset (&send_buffer_vl, '\0', sizeof (send_buffer_vl));
1337         memset (send_buffer_type, '\0', sizeof (send_buffer_type));
1339         cache_tree = avl_create ((int (*) (const void *, const void *)) strcmp);
1340         cache_flush_last = time (NULL);
1342         /* setup socket(s) and so on */
1343         if (sending_sockets != NULL)
1344                 plugin_register_write ("network", network_write);
1346         if ((listen_sockets_num != 0) && (listen_thread == 0))
1347         {
1348                 int status;
1350                 status = pthread_create (&listen_thread, NULL /* no attributes */,
1351                                 receive_thread, NULL /* no argument */);
1353                 if (status != 0)
1354                 {
1355                         char errbuf[1024];
1356                         ERROR ("network: pthread_create failed: %s",
1357                                         sstrerror (errno, errbuf,
1358                                                 sizeof (errbuf)));
1359                 }
1360         }
1361         return (0);
1362 } /* int network_init */
1364 void module_register (void)
1366         plugin_register_config ("network", network_config,
1367                         config_keys, config_keys_num);
1368         plugin_register_init   ("network", network_init);
1369 } /* void module_register */