2 * collectd - src/connectivity.c
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 * DEALINGS IN THE SOFTWARE.
24 * Andrew Bays <abays at redhat.com>
25 * Aneesh Puttur <aputtur at redhat.com>
32 #include "utils_complain.h"
33 #include "utils_ignorelist.h"
35 #include <asm/types.h>
38 #include <netinet/in.h>
42 #include <sys/socket.h>
45 #include <libmnl/libmnl.h>
46 #include <linux/netlink.h>
47 #include <linux/rtnetlink.h>
49 #include <yajl/yajl_common.h>
50 #include <yajl/yajl_gen.h>
51 #if HAVE_YAJL_YAJL_VERSION_H
52 #include <yajl/yajl_version.h>
54 #if defined(YAJL_MAJOR) && (YAJL_MAJOR > 1)
55 #define HAVE_YAJL_V2 1
58 #define MYPROTO NETLINK_ROUTE
60 #define LINK_STATE_DOWN 0
61 #define LINK_STATE_UP 1
62 #define LINK_STATE_UNKNOWN 2
64 #define CONNECTIVITY_DOMAIN_FIELD "domain"
65 #define CONNECTIVITY_DOMAIN_VALUE "stateChange"
66 #define CONNECTIVITY_EVENT_ID_FIELD "eventId"
67 #define CONNECTIVITY_EVENT_NAME_FIELD "eventName"
68 #define CONNECTIVITY_EVENT_NAME_DOWN_VALUE "down"
69 #define CONNECTIVITY_EVENT_NAME_UP_VALUE "up"
70 #define CONNECTIVITY_LAST_EPOCH_MICROSEC_FIELD "lastEpochMicrosec"
71 #define CONNECTIVITY_PRIORITY_FIELD "priority"
72 #define CONNECTIVITY_PRIORITY_VALUE "high"
73 #define CONNECTIVITY_REPORTING_ENTITY_NAME_FIELD "reportingEntityName"
74 #define CONNECTIVITY_REPORTING_ENTITY_NAME_VALUE "collectd connectivity plugin"
75 #define CONNECTIVITY_SEQUENCE_FIELD "sequence"
76 #define CONNECTIVITY_SEQUENCE_VALUE "0"
77 #define CONNECTIVITY_SOURCE_NAME_FIELD "sourceName"
78 #define CONNECTIVITY_START_EPOCH_MICROSEC_FIELD "startEpochMicrosec"
79 #define CONNECTIVITY_VERSION_FIELD "version"
80 #define CONNECTIVITY_VERSION_VALUE "1.0"
82 #define CONNECTIVITY_NEW_STATE_FIELD "newState"
83 #define CONNECTIVITY_NEW_STATE_FIELD_DOWN_VALUE "outOfService"
84 #define CONNECTIVITY_NEW_STATE_FIELD_UP_VALUE "inService"
85 #define CONNECTIVITY_OLD_STATE_FIELD "oldState"
86 #define CONNECTIVITY_OLD_STATE_FIELD_DOWN_VALUE "outOfService"
87 #define CONNECTIVITY_OLD_STATE_FIELD_UP_VALUE "inService"
88 #define CONNECTIVITY_STATE_CHANGE_FIELDS_FIELD "stateChangeFields"
89 #define CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_FIELD \
90 "stateChangeFieldsVersion"
91 #define CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_VALUE "1.0"
92 #define CONNECTIVITY_STATE_INTERFACE_FIELD "stateInterface"
98 struct interface_list_s {
102 uint32_t prev_status;
106 struct interface_list_s *next;
108 typedef struct interface_list_s interface_list_t;
114 static ignorelist_t *ignorelist = NULL;
116 static interface_list_t *interface_list_head = NULL;
117 static int monitor_all_interfaces = 1;
119 static int connectivity_netlink_thread_loop = 0;
120 static int connectivity_netlink_thread_error = 0;
121 static pthread_t connectivity_netlink_thread_id;
122 static int connectivity_dequeue_thread_loop = 0;
123 static pthread_t connectivity_dequeue_thread_id;
124 static pthread_mutex_t connectivity_threads_lock = PTHREAD_MUTEX_INITIALIZER;
125 static pthread_mutex_t connectivity_data_lock = PTHREAD_MUTEX_INITIALIZER;
126 static pthread_cond_t connectivity_cond = PTHREAD_COND_INITIALIZER;
127 static int nl_sock = -1;
128 static int event_id = 0;
129 static int statuses_to_send = 0;
131 static const char *config_keys[] = {"Interface", "IgnoreSelected"};
132 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
138 static int gen_message_payload(int state, int old_state, const char *interface,
139 cdtime_t timestamp, char **buf) {
140 const unsigned char *buf2;
142 char json_str[DATA_MAX_NAME_LEN];
144 #if !defined(HAVE_YAJL_V2)
145 yajl_gen_config conf = {0};
150 g = yajl_gen_alloc(NULL);
151 yajl_gen_config(g, yajl_gen_beautify, 0);
154 g = yajl_gen_alloc(&conf, NULL);
159 // *** BEGIN common event header ***
161 if (yajl_gen_map_open(g) != yajl_gen_status_ok)
165 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_DOMAIN_FIELD,
166 strlen(CONNECTIVITY_DOMAIN_FIELD)) != yajl_gen_status_ok)
169 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_DOMAIN_VALUE,
170 strlen(CONNECTIVITY_DOMAIN_VALUE)) != yajl_gen_status_ok)
174 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_EVENT_ID_FIELD,
175 strlen(CONNECTIVITY_EVENT_ID_FIELD)) !=
179 event_id = event_id + 1;
180 if (snprintf(json_str, sizeof(json_str), "%d", event_id) < 0) {
184 if (yajl_gen_number(g, json_str, strlen(json_str)) != yajl_gen_status_ok) {
189 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_EVENT_NAME_FIELD,
190 strlen(CONNECTIVITY_EVENT_NAME_FIELD)) !=
194 if (snprintf(json_str, sizeof(json_str), "interface %s %s", interface,
195 (state == 0 ? CONNECTIVITY_EVENT_NAME_DOWN_VALUE
196 : CONNECTIVITY_EVENT_NAME_UP_VALUE)) < 0) {
200 if (yajl_gen_string(g, (u_char *)json_str, strlen(json_str)) !=
201 yajl_gen_status_ok) {
206 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_LAST_EPOCH_MICROSEC_FIELD,
207 strlen(CONNECTIVITY_LAST_EPOCH_MICROSEC_FIELD)) !=
211 if (snprintf(json_str, sizeof(json_str), "%" PRIu64,
212 CDTIME_T_TO_US(cdtime())) < 0) {
216 if (yajl_gen_number(g, json_str, strlen(json_str)) != yajl_gen_status_ok) {
221 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_PRIORITY_FIELD,
222 strlen(CONNECTIVITY_PRIORITY_FIELD)) !=
226 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_PRIORITY_VALUE,
227 strlen(CONNECTIVITY_PRIORITY_VALUE)) !=
231 // reportingEntityName
232 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_REPORTING_ENTITY_NAME_FIELD,
233 strlen(CONNECTIVITY_REPORTING_ENTITY_NAME_FIELD)) !=
237 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_REPORTING_ENTITY_NAME_VALUE,
238 strlen(CONNECTIVITY_REPORTING_ENTITY_NAME_VALUE)) !=
243 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_SEQUENCE_FIELD,
244 strlen(CONNECTIVITY_SEQUENCE_FIELD)) !=
248 if (yajl_gen_number(g, CONNECTIVITY_SEQUENCE_VALUE,
249 strlen(CONNECTIVITY_SEQUENCE_VALUE)) !=
254 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_SOURCE_NAME_FIELD,
255 strlen(CONNECTIVITY_SOURCE_NAME_FIELD)) !=
259 if (yajl_gen_string(g, (u_char *)interface, strlen(interface)) !=
263 // startEpochMicrosec
264 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_START_EPOCH_MICROSEC_FIELD,
265 strlen(CONNECTIVITY_START_EPOCH_MICROSEC_FIELD)) !=
269 if (snprintf(json_str, sizeof(json_str), "%" PRIu64,
270 CDTIME_T_TO_US(timestamp)) < 0) {
274 if (yajl_gen_number(g, json_str, strlen(json_str)) != yajl_gen_status_ok) {
279 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_VERSION_FIELD,
280 strlen(CONNECTIVITY_VERSION_FIELD)) != yajl_gen_status_ok)
283 if (yajl_gen_number(g, CONNECTIVITY_VERSION_VALUE,
284 strlen(CONNECTIVITY_VERSION_VALUE)) != yajl_gen_status_ok)
287 // *** END common event header ***
289 // *** BEGIN state change fields ***
291 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_STATE_CHANGE_FIELDS_FIELD,
292 strlen(CONNECTIVITY_STATE_CHANGE_FIELDS_FIELD)) !=
296 if (yajl_gen_map_open(g) != yajl_gen_status_ok)
300 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_NEW_STATE_FIELD,
301 strlen(CONNECTIVITY_NEW_STATE_FIELD)) !=
306 (state == 0 ? strlen(CONNECTIVITY_NEW_STATE_FIELD_DOWN_VALUE)
307 : strlen(CONNECTIVITY_NEW_STATE_FIELD_UP_VALUE));
309 if (yajl_gen_string(g,
310 (u_char *)(state == 0
311 ? CONNECTIVITY_NEW_STATE_FIELD_DOWN_VALUE
312 : CONNECTIVITY_NEW_STATE_FIELD_UP_VALUE),
313 new_state_len) != yajl_gen_status_ok)
317 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_OLD_STATE_FIELD,
318 strlen(CONNECTIVITY_OLD_STATE_FIELD)) !=
323 (old_state == 0 ? strlen(CONNECTIVITY_OLD_STATE_FIELD_DOWN_VALUE)
324 : strlen(CONNECTIVITY_OLD_STATE_FIELD_UP_VALUE));
326 if (yajl_gen_string(g,
327 (u_char *)(old_state == 0
328 ? CONNECTIVITY_OLD_STATE_FIELD_DOWN_VALUE
329 : CONNECTIVITY_OLD_STATE_FIELD_UP_VALUE),
330 old_state_len) != yajl_gen_status_ok)
333 // stateChangeFieldsVersion
334 if (yajl_gen_string(g,
335 (u_char *)CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_FIELD,
336 strlen(CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_FIELD)) !=
340 if (yajl_gen_number(g, CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_VALUE,
341 strlen(CONNECTIVITY_STATE_CHANGE_FIELDS_VERSION_VALUE)) !=
346 if (yajl_gen_string(g, (u_char *)CONNECTIVITY_STATE_INTERFACE_FIELD,
347 strlen(CONNECTIVITY_STATE_INTERFACE_FIELD)) !=
351 if (yajl_gen_string(g, (u_char *)interface, strlen(interface)) !=
355 // close state change and header fields
356 if (yajl_gen_map_close(g) != yajl_gen_status_ok ||
357 yajl_gen_map_close(g) != yajl_gen_status_ok)
360 // *** END state change fields ***
362 if (yajl_gen_get_buf(g, &buf2, &len) != yajl_gen_status_ok)
365 *buf = strdup((char *)buf2);
368 ERROR("connectivity plugin: strdup failed during gen_message_payload: %s",
379 ERROR("connectivity plugin: gen_message_payload failed to generate JSON");
383 static interface_list_t *add_interface(const char *interface, int status,
385 interface_list_t *il = calloc(1, sizeof(*il));
388 ERROR("connectivity plugin: calloc failed during add_interface: %s",
393 char *interface2 = strdup(interface);
394 if (interface2 == NULL) {
396 ERROR("connectivity plugin: strdup failed during add_interface: %s",
401 il->interface = interface2;
403 il->prev_status = prev_status;
404 il->timestamp = cdtime();
406 il->next = interface_list_head;
407 interface_list_head = il;
409 DEBUG("connectivity plugin: added interface %s", interface2);
414 static int connectivity_link_state(struct nlmsghdr *msg) {
415 pthread_mutex_lock(&connectivity_data_lock);
418 struct ifinfomsg *ifi = mnl_nlmsg_get_payload(msg);
420 /* Scan attribute list for device name. */
421 mnl_attr_for_each(attr, msg, sizeof(*ifi)) {
422 if (mnl_attr_get_type(attr) != IFLA_IFNAME)
425 if (mnl_attr_validate(attr, MNL_TYPE_STRING) < 0) {
426 ERROR("connectivity plugin: connectivity_link_state: IFLA_IFNAME "
429 pthread_mutex_unlock(&connectivity_data_lock);
433 const char *dev = mnl_attr_get_str(attr);
435 // Check the list of interfaces we should monitor, if we've chosen
436 // a subset. If we don't care about this one, abort.
437 if (ignorelist_match(ignorelist, dev) != 0) {
438 DEBUG("connectivity plugin: Ignoring link state change for unmonitored "
444 interface_list_t *il = NULL;
446 for (il = interface_list_head; il != NULL; il = il->next)
447 if (strcmp(dev, il->interface) == 0)
451 // We haven't encountered this interface yet, so add it to the linked list
452 il = add_interface(dev, LINK_STATE_UNKNOWN, LINK_STATE_UNKNOWN);
455 ERROR("connectivity plugin: unable to add interface %s during "
456 "connectivity_link_state",
462 uint32_t prev_status = il->status;
464 ((ifi->ifi_flags & IFF_RUNNING) ? LINK_STATE_UP : LINK_STATE_DOWN);
465 il->timestamp = cdtime();
467 // If the new status is different than the previous status,
468 // store the previous status and set sent to zero, and set the
469 // global flag to indicate there are statuses to dispatch
470 if (il->status != prev_status) {
471 il->prev_status = prev_status;
473 statuses_to_send = 1;
476 DEBUG("connectivity plugin (%llu): Interface %s status is now %s",
477 il->timestamp, dev, ((ifi->ifi_flags & IFF_RUNNING) ? "UP" : "DOWN"));
479 // no need to loop again, we found the interface name attr
480 // (otherwise the first if-statement in the loop would
481 // have moved us on with 'continue')
485 pthread_mutex_unlock(&connectivity_data_lock);
490 static int msg_handler(struct nlmsghdr *msg) {
491 // We are only interested in RTM_NEWLINK messages
492 if (msg->nlmsg_type != RTM_NEWLINK) {
495 return connectivity_link_state(msg);
498 static int read_event(int (*msg_handler)(struct nlmsghdr *)) {
500 int recv_flags = MSG_DONTWAIT;
502 if (nl_sock == -1 || msg_handler == NULL)
506 pthread_mutex_lock(&connectivity_threads_lock);
508 if (connectivity_netlink_thread_loop <= 0) {
509 pthread_mutex_unlock(&connectivity_threads_lock);
513 pthread_mutex_unlock(&connectivity_threads_lock);
516 int status = recv(nl_sock, buf, sizeof(buf), recv_flags);
520 // If there were no more messages to drain from the socket,
521 // then signal the dequeue thread and allow it to dispatch
522 // any saved interface status changes. Then continue, but
523 // block and wait for new messages
524 if (errno == EWOULDBLOCK || errno == EAGAIN) {
525 pthread_cond_signal(&connectivity_cond);
531 if (errno == EINTR) {
532 // Interrupt, so just continue and try again
536 /* Anything else is an error */
537 ERROR("connectivity plugin: read_event: Error recv: %d", status);
541 // Message received successfully, so we'll stop blocking on the
542 // receive call for now (until we get a "would block" error, which
543 // will be handled above)
544 recv_flags = MSG_DONTWAIT;
547 DEBUG("connectivity plugin: read_event: EOF");
550 /* We need to handle more than one message per 'recvmsg' */
551 for (struct nlmsghdr *h = (struct nlmsghdr *)buf;
552 NLMSG_OK(h, (unsigned int)status); h = NLMSG_NEXT(h, status)) {
554 if (h->nlmsg_type == NLMSG_DONE)
557 /* Message is some kind of error */
558 if (h->nlmsg_type == NLMSG_ERROR) {
559 struct nlmsgerr *l_err = (struct nlmsgerr *)NLMSG_DATA(h);
560 ERROR("connectivity plugin: read_event: Message is an error: %d",
565 /* Call message handler */
567 ret = (*msg_handler)(h);
569 ERROR("connectivity plugin: read_event: Message handler error %d",
574 ERROR("connectivity plugin: read_event: Error NULL message handler");
583 static void connectivity_dispatch_notification(const char *interface,
584 gauge_t value, gauge_t old_value,
585 cdtime_t timestamp) {
588 .severity = (value == LINK_STATE_UP ? NOTIF_OKAY : NOTIF_FAILURE),
590 .plugin = "connectivity",
592 .type_instance = "interface_status",
595 sstrncpy(n.host, hostname_g, sizeof(n.host));
596 sstrncpy(n.plugin_instance, interface, sizeof(n.plugin_instance));
600 gen_message_payload(value, old_value, interface, timestamp, &buf);
602 int status = plugin_notification_meta_add_string(&n, "ves", buf);
606 ERROR("connectivity plugin: unable to set notification VES metadata: %s",
611 DEBUG("connectivity plugin: notification VES metadata: %s",
612 n.meta->nm_value.nm_string);
614 DEBUG("connectivity plugin: dispatching state %d for interface %s",
615 (int)value, interface);
617 plugin_dispatch_notification(&n);
618 plugin_notification_meta_free(n.meta);
620 // strdup'd in gen_message_payload
625 // NOTE: Caller MUST hold connectivity_data_lock when calling this function
626 static void send_interface_status() {
627 for (interface_list_t *il = interface_list_head; il != NULL;
628 il = il->next) /* {{{ */
630 uint32_t status = il->status;
631 uint32_t prev_status = il->prev_status;
632 uint32_t sent = il->sent;
634 if (status != prev_status && sent == 0) {
635 connectivity_dispatch_notification(il->interface, status, prev_status,
639 } /* }}} for (il = interface_list_head; il != NULL; il = il->next) */
641 statuses_to_send = 0;
644 static void read_interface_status() /* {{{ */
646 pthread_mutex_lock(&connectivity_data_lock);
648 // If we don't have any interface statuses to dispatch,
649 // then we wait until signalled
650 if (!statuses_to_send)
651 pthread_cond_wait(&connectivity_cond, &connectivity_data_lock);
653 send_interface_status();
655 pthread_mutex_unlock(&connectivity_data_lock);
656 } /* }}} int *read_interface_status */
658 static void *connectivity_netlink_thread(void *arg) /* {{{ */
660 pthread_mutex_lock(&connectivity_threads_lock);
662 while (connectivity_netlink_thread_loop > 0) {
663 pthread_mutex_unlock(&connectivity_threads_lock);
665 int status = read_event(msg_handler);
667 pthread_mutex_lock(&connectivity_threads_lock);
670 connectivity_netlink_thread_error = 1;
673 } /* while (connectivity_netlink_thread_loop > 0) */
675 pthread_mutex_unlock(&connectivity_threads_lock);
678 } /* }}} void *connectivity_netlink_thread */
680 static void *connectivity_dequeue_thread(void *arg) /* {{{ */
682 pthread_mutex_lock(&connectivity_threads_lock);
684 while (connectivity_dequeue_thread_loop > 0) {
685 pthread_mutex_unlock(&connectivity_threads_lock);
687 read_interface_status();
689 pthread_mutex_lock(&connectivity_threads_lock);
690 } /* while (connectivity_dequeue_thread_loop > 0) */
692 pthread_mutex_unlock(&connectivity_threads_lock);
695 } /* }}} void *connectivity_dequeue_thread */
697 static int nl_connect() {
698 struct sockaddr_nl sa_nl = {
699 .nl_family = AF_NETLINK,
700 .nl_groups = RTMGRP_LINK,
704 nl_sock = socket(AF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
706 ERROR("connectivity plugin: socket open failed: %s", STRERRNO);
710 int rc = bind(nl_sock, (struct sockaddr *)&sa_nl, sizeof(sa_nl));
712 ERROR("connectivity plugin: socket bind failed: %s", STRERRNO);
721 static int start_netlink_thread(void) /* {{{ */
723 pthread_mutex_lock(&connectivity_threads_lock);
725 if (connectivity_netlink_thread_loop != 0) {
726 pthread_mutex_unlock(&connectivity_threads_lock);
730 connectivity_netlink_thread_loop = 1;
731 connectivity_netlink_thread_error = 0;
736 status = nl_connect();
739 pthread_mutex_unlock(&connectivity_threads_lock);
744 status = plugin_thread_create(&connectivity_netlink_thread_id,
745 /* attr = */ NULL, connectivity_netlink_thread,
746 /* arg = */ (void *)0, "connectivity");
748 connectivity_netlink_thread_loop = 0;
749 ERROR("connectivity plugin: Starting thread failed.");
750 pthread_mutex_unlock(&connectivity_threads_lock);
752 int status2 = close(nl_sock);
755 ERROR("connectivity plugin: failed to close socket %d: %d (%s)", nl_sock,
764 pthread_mutex_unlock(&connectivity_threads_lock);
769 static int start_dequeue_thread(void) /* {{{ */
771 pthread_mutex_lock(&connectivity_threads_lock);
773 if (connectivity_dequeue_thread_loop != 0) {
774 pthread_mutex_unlock(&connectivity_threads_lock);
778 connectivity_dequeue_thread_loop = 1;
781 plugin_thread_create(&connectivity_dequeue_thread_id,
782 /* attr = */ NULL, connectivity_dequeue_thread,
783 /* arg = */ (void *)0, "connectivity");
785 connectivity_dequeue_thread_loop = 0;
786 ERROR("connectivity plugin: Starting dequeue thread failed.");
787 pthread_mutex_unlock(&connectivity_threads_lock);
791 pthread_mutex_unlock(&connectivity_threads_lock);
794 } /* }}} int start_dequeue_thread */
796 static int start_threads(void) /* {{{ */
798 int status = start_netlink_thread();
799 int status2 = start_dequeue_thread();
805 } /* }}} int start_threads */
807 static int stop_netlink_thread(int shutdown) /* {{{ */
812 socket_status = close(nl_sock);
813 if (socket_status != 0) {
814 ERROR("connectivity plugin: failed to close socket %d: %d (%s)", nl_sock,
815 socket_status, STRERRNO);
822 pthread_mutex_lock(&connectivity_threads_lock);
824 if (connectivity_netlink_thread_loop == 0) {
825 pthread_mutex_unlock(&connectivity_threads_lock);
826 // Thread has already been terminated, nothing more to attempt
827 return socket_status;
830 // Set thread termination status
831 connectivity_netlink_thread_loop = 0;
832 pthread_mutex_unlock(&connectivity_threads_lock);
834 // Let threads waiting on access to the interface list know to move
835 // on such that they'll see the thread's termination status
836 pthread_cond_broadcast(&connectivity_cond);
841 // Since the thread is blocking, calling pthread_join
842 // doesn't actually succeed in stopping it. It will stick around
843 // until a NETLINK message is received on the socket (at which
844 // it will realize that "connectivity_netlink_thread_loop" is 0 and will
845 // break out of the read loop and be allowed to die). This is
846 // fine when the process isn't supposed to be exiting, but in
847 // the case of a process shutdown, we don't want to have an
848 // idle thread hanging around. Calling pthread_cancel here in
849 // the case of a shutdown is just assures that the thread is
850 // gone and that the process has been fully terminated.
852 DEBUG("connectivity plugin: Canceling netlink thread for process shutdown");
854 thread_status = pthread_cancel(connectivity_netlink_thread_id);
856 if (thread_status != 0 && thread_status != ESRCH) {
857 ERROR("connectivity plugin: Unable to cancel netlink thread: %d",
864 pthread_join(connectivity_netlink_thread_id, /* return = */ NULL);
865 if (thread_status != 0 && thread_status != ESRCH) {
866 ERROR("connectivity plugin: Stopping netlink thread failed: %d",
873 pthread_mutex_lock(&connectivity_threads_lock);
874 memset(&connectivity_netlink_thread_id, 0,
875 sizeof(connectivity_netlink_thread_id));
876 connectivity_netlink_thread_error = 0;
877 pthread_mutex_unlock(&connectivity_threads_lock);
879 DEBUG("connectivity plugin: Finished requesting stop of netlink thread");
881 if (socket_status != 0)
882 return socket_status;
884 return thread_status;
887 static int stop_dequeue_thread() /* {{{ */
889 pthread_mutex_lock(&connectivity_threads_lock);
891 if (connectivity_dequeue_thread_loop == 0) {
892 pthread_mutex_unlock(&connectivity_threads_lock);
896 // Set thread termination status
897 connectivity_dequeue_thread_loop = 0;
898 pthread_mutex_unlock(&connectivity_threads_lock);
900 // Let threads waiting on access to the interface list know to move
901 // on such that they'll see the threads termination status
902 pthread_cond_broadcast(&connectivity_cond);
904 // Calling pthread_cancel here just assures that the thread is
905 // gone and that the process has been fully terminated.
907 DEBUG("connectivity plugin: Canceling dequeue thread for process shutdown");
909 int status = pthread_cancel(connectivity_dequeue_thread_id);
911 if (status != 0 && status != ESRCH) {
912 ERROR("connectivity plugin: Unable to cancel dequeue thread: %d", status);
917 pthread_mutex_lock(&connectivity_threads_lock);
918 memset(&connectivity_dequeue_thread_id, 0,
919 sizeof(connectivity_dequeue_thread_id));
920 pthread_mutex_unlock(&connectivity_threads_lock);
922 DEBUG("connectivity plugin: Finished requesting stop of dequeue thread");
925 } /* }}} int stop_dequeue_thread */
927 static int stop_threads() /* {{{ */
929 int status = stop_netlink_thread(1);
930 int status2 = stop_dequeue_thread();
936 } /* }}} int stop_threads */
938 static int connectivity_init(void) /* {{{ */
940 if (monitor_all_interfaces) {
941 NOTICE("connectivity plugin: No interfaces have been selected, so all will "
945 return start_threads();
946 } /* }}} int connectivity_init */
948 static int connectivity_config(const char *key, const char *value) /* {{{ */
950 if (ignorelist == NULL) {
951 ignorelist = ignorelist_create(/* invert = */ 1);
953 if (ignorelist == NULL)
957 if (strcasecmp(key, "Interface") == 0) {
958 ignorelist_add(ignorelist, value);
959 monitor_all_interfaces = 0;
960 } else if (strcasecmp(key, "IgnoreSelected") == 0) {
964 ignorelist_set_invert(ignorelist, invert);
970 } /* }}} int connectivity_config */
972 static int connectivity_read(void) /* {{{ */
974 pthread_mutex_lock(&connectivity_threads_lock);
976 if (connectivity_netlink_thread_error != 0) {
978 pthread_mutex_unlock(&connectivity_threads_lock);
980 ERROR("connectivity plugin: The netlink thread had a problem. Restarting "
983 stop_netlink_thread(0);
985 for (interface_list_t *il = interface_list_head; il != NULL;
987 il->status = LINK_STATE_UNKNOWN;
988 il->prev_status = LINK_STATE_UNKNOWN;
992 start_netlink_thread();
995 } /* if (connectivity_netlink_thread_error != 0) */
997 pthread_mutex_unlock(&connectivity_threads_lock);
1000 } /* }}} int connectivity_read */
1002 static int connectivity_shutdown(void) /* {{{ */
1004 DEBUG("connectivity plugin: Shutting down thread.");
1006 int status = stop_threads();
1008 interface_list_t *il = interface_list_head;
1009 while (il != NULL) {
1010 interface_list_t *il_next;
1014 sfree(il->interface);
1020 ignorelist_free(ignorelist);
1023 } /* }}} int connectivity_shutdown */
1025 void module_register(void) {
1026 plugin_register_config("connectivity", connectivity_config, config_keys,
1028 plugin_register_init("connectivity", connectivity_init);
1029 plugin_register_read("connectivity", connectivity_read);
1030 plugin_register_shutdown("connectivity", connectivity_shutdown);
1031 } /* void module_register */