2 * collectd - src/tcpconns.c
3 * Copyright (C) 2007,2008 Florian octo Forster
4 * Copyright (C) 2008 Michael Stapelberg
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <octo at verplant.org>
21 * Michael Stapelberg <michael+git at stapelberg.de>
25 * Code within `HAVE_LIBKVM_NLIST' blocks is provided under the following
28 * $collectd: parts of tcpconns.c, 2008/08/08 03:48:30 Michael Stapelberg $
29 * $OpenBSD: inet.c,v 1.100 2007/06/19 05:28:30 ray Exp $
30 * $NetBSD: inet.c,v 1.14 1995/10/03 21:42:37 thorpej Exp $
32 * Copyright (c) 1983, 1988, 1993
33 * The Regents of the University of California. All rights reserved.
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
38 * 1. Redistributions of source code must retain the above copyright
39 * notice, this list of conditions and the following disclaimer.
40 * 2. Redistributions in binary form must reproduce the above copyright
41 * notice, this list of conditions and the following disclaimer in the
42 * documentation and/or other materials provided with the distribution.
43 * 3. Neither the name of the University nor the names of its contributors
44 * may be used to endorse or promote products derived from this software
45 * without specific prior written permission.
47 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
48 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 #if defined(__OpenBSD__) || defined(__NetBSD__)
65 #undef HAVE_SYSCTLBYNAME /* force HAVE_LIBKVM_NLIST path */
68 #if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !HAVE_LIBKVM_NLIST && !KERNEL_AIX
69 # error "No applicable input method."
73 # include <asm/types.h>
74 /* sys/socket.h is necessary to compile when using netlink on older systems. */
75 # include <sys/socket.h>
76 # include <linux/netlink.h>
77 # include <linux/inet_diag.h>
78 # include <sys/socket.h>
79 # include <arpa/inet.h>
80 /* #endif KERNEL_LINUX */
82 #elif HAVE_SYSCTLBYNAME
83 # include <sys/socketvar.h>
84 # include <sys/sysctl.h>
86 /* Some includes needed for compiling on FreeBSD */
89 # include <sys/types.h>
92 # include <sys/socket.h>
98 # include <net/route.h>
99 # include <netinet/in.h>
100 # include <netinet/in_systm.h>
101 # include <netinet/ip.h>
102 # include <netinet/ip6.h>
103 # include <netinet/in_pcb.h>
104 # include <netinet/ip_var.h>
105 # include <netinet/tcp.h>
106 # include <netinet/tcpip.h>
107 # include <netinet/tcp_seq.h>
108 # include <netinet/tcp_var.h>
109 /* #endif HAVE_SYSCTLBYNAME */
111 /* This is for OpenBSD and NetBSD. */
112 #elif HAVE_LIBKVM_NLIST
113 # include <sys/queue.h>
114 # include <sys/socket.h>
115 # include <net/route.h>
116 # include <netinet/in.h>
117 # include <netinet/in_systm.h>
118 # include <netinet/ip.h>
119 # include <netinet/ip_var.h>
120 # include <netinet/in_pcb.h>
121 # include <netinet/tcp.h>
122 # include <netinet/tcp_timer.h>
123 # include <netinet/tcp_var.h>
125 # include <arpa/inet.h>
126 # if !defined(HAVE_BSD_NLIST_H) || !HAVE_BSD_NLIST_H
128 # else /* HAVE_BSD_NLIST_H */
129 # include <bsd/nlist.h>
132 /* #endif HAVE_LIBKVM_NLIST */
135 # include <arpa/inet.h>
136 # include <sys/socketvar.h>
137 #endif /* KERNEL_AIX */
140 static const char *tcp_state[] =
156 # define TCP_STATE_LISTEN 10
157 # define TCP_STATE_MIN 1
158 # define TCP_STATE_MAX 11
159 /* #endif KERNEL_LINUX */
161 #elif HAVE_SYSCTLBYNAME
162 static const char *tcp_state[] =
177 # define TCP_STATE_LISTEN 1
178 # define TCP_STATE_MIN 0
179 # define TCP_STATE_MAX 10
180 /* #endif HAVE_SYSCTLBYNAME */
182 #elif HAVE_LIBKVM_NLIST
183 static const char *tcp_state[] =
199 static u_long inpcbtable_off = 0;
200 struct inpcbtable *inpcbtable_ptr = NULL;
202 # define TCP_STATE_LISTEN 1
203 # define TCP_STATE_MIN 1
204 # define TCP_STATE_MAX 10
205 /* #endif HAVE_LIBKVM_NLIST */
208 static const char *tcp_state[] =
223 # define TCP_STATE_LISTEN 1
224 # define TCP_STATE_MIN 0
225 # define TCP_STATE_MAX 10
227 struct netinfo_conn {
231 struct in6_addr dstaddr;
234 struct in6_addr srcaddr;
235 uint32_t unknow4[36];
240 struct netinfo_header {
245 # define NETINFO_TCP 3
246 extern int netinfo (int proto, void *data, int *size, int n);
247 #endif /* KERNEL_AIX */
249 #define PORT_COLLECT_LOCAL 0x01
250 #define PORT_COLLECT_REMOTE 0x02
251 #define PORT_IS_LISTENING 0x04
253 typedef struct port_entry_s
257 uint32_t count_local[TCP_STATE_MAX + 1];
258 uint32_t count_remote[TCP_STATE_MAX + 1];
259 struct port_entry_s *next;
262 static const char *config_keys[] =
268 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
270 static int port_collect_listening = 0;
271 static port_entry_t *port_list_head = NULL;
273 static void conn_submit_port_entry (port_entry_t *pe)
276 value_list_t vl = VALUE_LIST_INIT;
281 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
282 sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
283 sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
285 if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
286 || (pe->flags & PORT_COLLECT_LOCAL))
288 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
289 "%"PRIu16"-local", pe->port);
291 for (i = 1; i <= TCP_STATE_MAX; i++)
293 vl.values[0].gauge = pe->count_local[i];
295 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
297 plugin_dispatch_values (&vl);
301 if (pe->flags & PORT_COLLECT_REMOTE)
303 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
304 "%"PRIu16"-remote", pe->port);
306 for (i = 1; i <= TCP_STATE_MAX; i++)
308 vl.values[0].gauge = pe->count_remote[i];
310 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
312 plugin_dispatch_values (&vl);
315 } /* void conn_submit */
317 static void conn_submit_all (void)
321 for (pe = port_list_head; pe != NULL; pe = pe->next)
322 conn_submit_port_entry (pe);
323 } /* void conn_submit_all */
325 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
329 ret = port_list_head;
332 if (ret->port == port)
337 if ((ret == NULL) && (create != 0))
339 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
342 memset (ret, '\0', sizeof (port_entry_t));
345 ret->next = port_list_head;
346 port_list_head = ret;
350 } /* port_entry_t *conn_get_port_entry */
352 /* Removes ports that were added automatically due to the `ListeningPorts'
353 * setting but which are no longer listening. */
354 static void conn_reset_port_entry (void)
356 port_entry_t *prev = NULL;
357 port_entry_t *pe = port_list_head;
361 /* If this entry was created while reading the files (ant not when handling
362 * the configuration) remove it now. */
363 if ((pe->flags & (PORT_COLLECT_LOCAL
364 | PORT_COLLECT_REMOTE
365 | PORT_IS_LISTENING)) == 0)
367 port_entry_t *next = pe->next;
369 DEBUG ("tcpconns plugin: Removing temporary entry "
370 "for listening port %"PRIu16, pe->port);
373 port_list_head = next;
383 memset (pe->count_local, '\0', sizeof (pe->count_local));
384 memset (pe->count_remote, '\0', sizeof (pe->count_remote));
385 pe->flags &= ~PORT_IS_LISTENING;
389 } /* void conn_reset_port_entry */
391 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
393 port_entry_t *pe = NULL;
395 if ((state > TCP_STATE_MAX)
396 #if TCP_STATE_MIN > 0
397 || (state < TCP_STATE_MIN)
401 NOTICE ("tcpconns plugin: Ignoring connection with "
402 "unknown state 0x%02"PRIx8".", state);
406 /* Listening sockets */
407 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
409 pe = conn_get_port_entry (port_local, 1 /* create */);
411 pe->flags |= PORT_IS_LISTENING;
414 DEBUG ("tcpconns plugin: Connection %"PRIu16" <-> %"PRIu16" (%s)",
415 port_local, port_remote, tcp_state[state]);
417 pe = conn_get_port_entry (port_local, 0 /* no create */);
419 pe->count_local[state]++;
421 pe = conn_get_port_entry (port_remote, 0 /* no create */);
423 pe->count_remote[state]++;
426 } /* int conn_handle_ports */
429 static int conn_read_netlink (void)
432 struct sockaddr_nl nladdr;
435 struct inet_diag_req r;
439 struct inet_diag_msg *r;
441 static uint32_t sequence_number = 0;
443 if ((fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_INET_DIAG)) < 0)
446 memset(&nladdr, 0, sizeof(nladdr));
447 nladdr.nl_family = AF_NETLINK;
449 req.nlh.nlmsg_len = sizeof(req);
450 req.nlh.nlmsg_type = TCPDIAG_GETSOCK;
451 /* NLM_F_ROOT: return the complete table instead of a single entry. */
452 req.nlh.nlmsg_flags = NLM_F_ROOT | NLM_F_MATCH | NLM_F_REQUEST;
453 req.nlh.nlmsg_pid = 0;
454 /* The sequence_number is used to track our messages. Since netlink is not
455 * reliable, we don't want to end up with a corrupt or incomplete old
456 * message in case the system is/was out of memory. */
457 req.nlh.nlmsg_seq = ++sequence_number;
458 memset(&req.r, 0, sizeof(req.r));
459 req.r.idiag_family = AF_INET;
460 req.r.idiag_states = 0xfff;
464 iov.iov_len = sizeof(req);
466 msg = (struct msghdr) {
467 .msg_name = (void*)&nladdr,
468 .msg_namelen = sizeof(nladdr),
473 if (sendmsg (fd, &msg, 0) < 0)
480 iov.iov_len = sizeof(buf);
487 msg = (struct msghdr) {
488 (void*)&nladdr, sizeof(nladdr),
494 status = recvmsg(fd, &msg, 0);
509 h = (struct nlmsghdr*)buf;
510 while (NLMSG_OK(h, status))
512 if (h->nlmsg_seq == sequence_number)
514 if (h->nlmsg_type == NLMSG_DONE)
519 else if (h->nlmsg_type == NLMSG_ERROR)
527 /* This code does not (need to) distinguish between IPv4 and IPv6. */
528 conn_handle_ports (ntohs(r->id.idiag_sport),
529 ntohs(r->id.idiag_dport),
532 h = NLMSG_NEXT(h, status);
537 } /* int conn_read_netlink */
539 static int conn_handle_line (char *buffer)
546 char *port_local_str;
547 char *port_remote_str;
549 uint16_t port_remote;
553 int buffer_len = strlen (buffer);
555 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
556 buffer[--buffer_len] = '\0';
560 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
563 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
567 port_local_str = strchr (fields[1], ':');
568 port_remote_str = strchr (fields[2], ':');
570 if ((port_local_str == NULL) || (port_remote_str == NULL))
574 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
578 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
579 if ((endptr == NULL) || (*endptr != '\0'))
583 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
584 if ((endptr == NULL) || (*endptr != '\0'))
588 state = (uint8_t) strtol (fields[3], &endptr, 16);
589 if ((endptr == NULL) || (*endptr != '\0'))
592 return (conn_handle_ports (port_local, port_remote, state));
593 } /* int conn_handle_line */
595 static int conn_read_file (const char *file)
600 fh = fopen (file, "r");
604 while (fgets (buffer, sizeof (buffer), fh) != NULL)
606 conn_handle_line (buffer);
607 } /* while (fgets) */
612 } /* int conn_read_file */
613 /* #endif KERNEL_LINUX */
615 #elif HAVE_SYSCTLBYNAME
616 /* #endif HAVE_SYSCTLBYNAME */
618 #elif HAVE_LIBKVM_NLIST
619 #endif /* HAVE_LIBKVM_NLIST */
621 static int conn_config (const char *key, const char *value)
623 if (strcasecmp (key, "ListeningPorts") == 0)
626 port_collect_listening = 1;
628 port_collect_listening = 0;
630 else if ((strcasecmp (key, "LocalPort") == 0)
631 || (strcasecmp (key, "RemotePort") == 0))
634 int port = atoi (value);
636 if ((port < 1) || (port > 65535))
638 ERROR ("tcpconns plugin: Invalid port: %i", port);
642 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
645 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
649 if (strcasecmp (key, "LocalPort") == 0)
650 pe->flags |= PORT_COLLECT_LOCAL;
652 pe->flags |= PORT_COLLECT_REMOTE;
660 } /* int conn_config */
663 static int conn_init (void)
665 if (port_list_head == NULL)
666 port_collect_listening = 1;
669 } /* int conn_init */
671 static int conn_read (void)
675 conn_reset_port_entry ();
677 /* Try to use netlink for getting this data, it is _much_ faster on systems
678 * with a large amount of connections. */
679 if (!conn_read_netlink ())
681 if (conn_read_file ("/proc/net/tcp") != 0)
683 if (conn_read_file ("/proc/net/tcp6") != 0)
693 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
699 } /* int conn_read */
700 /* #endif KERNEL_LINUX */
702 #elif HAVE_SYSCTLBYNAME
703 static int conn_read (void)
709 struct xinpgen *in_orig;
710 struct xinpgen *in_ptr;
712 conn_reset_port_entry ();
715 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
718 ERROR ("tcpconns plugin: sysctlbyname failed.");
722 buffer = (char *) malloc (buffer_len);
725 ERROR ("tcpconns plugin: malloc failed.");
729 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
732 ERROR ("tcpconns plugin: sysctlbyname failed.");
737 if (buffer_len <= sizeof (struct xinpgen))
739 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
744 in_orig = (struct xinpgen *) buffer;
745 for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
746 in_ptr->xig_len > sizeof (struct xinpgen);
747 in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
749 struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
750 struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
751 struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
753 /* Ignore non-TCP sockets */
754 if (so->xso_protocol != IPPROTO_TCP)
757 /* Ignore PCBs which were freed during copyout. */
758 if (inp->inp_gencnt > in_orig->xig_gen)
761 if (((inp->inp_vflag & INP_IPV4) == 0)
762 && ((inp->inp_vflag & INP_IPV6) == 0))
765 conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
776 } /* int conn_read */
777 /* #endif HAVE_SYSCTLBYNAME */
779 #elif HAVE_LIBKVM_NLIST
780 static int kread (u_long addr, void *buf, int size)
784 status = kvm_read (kvmd, addr, buf, size);
787 ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
788 status, size, kvm_geterr (kvmd));
794 static int conn_init (void)
796 char buf[_POSIX2_LINE_MAX];
805 kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
808 ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
812 status = kvm_nlist (kvmd, nl);
815 ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
819 if (nl[N_TCBTABLE].n_type == 0)
821 ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
822 "N_TCBTABLE is invalid.");
826 inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
827 inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
830 } /* int conn_init */
832 static int conn_read (void)
834 struct inpcbtable table;
841 conn_reset_port_entry ();
843 /* Read the pcbtable from the kernel */
844 status = kread (inpcbtable_off, &table, sizeof (table));
848 /* Get the `head' pcb */
849 head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
850 /* Get the first pcb */
851 next = (struct inpcb *)CIRCLEQ_FIRST (&table.inpt_queue);
855 /* Read the pcb pointed to by `next' into `inpcb' */
856 kread ((u_long) next, &inpcb, sizeof (inpcb));
859 next = (struct inpcb *)CIRCLEQ_NEXT (&inpcb, inp_queue);
861 /* Ignore sockets, that are not connected. */
863 if (inpcb.inp_af == AF_INET6)
864 continue; /* XXX see netbsd/src/usr.bin/netstat/inet6.c */
866 if (!(inpcb.inp_flags & INP_IPV6)
867 && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
869 if ((inpcb.inp_flags & INP_IPV6)
870 && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
874 kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
875 conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
876 } /* while (next != head) */
882 /* #endif HAVE_LIBKVM_NLIST */
886 static int conn_read (void)
892 struct netinfo_header *header;
893 struct netinfo_conn *conn;
895 conn_reset_port_entry ();
897 size = netinfo(NETINFO_TCP, 0, 0, 0);
900 ERROR ("tcpconns plugin: netinfo failed return: %i", size);
907 if ((size - sizeof (struct netinfo_header)) % sizeof (struct netinfo_conn))
909 ERROR ("tcpconns plugin: invalid buffer size");
916 ERROR ("tcpconns plugin: malloc failed");
920 if (netinfo(NETINFO_TCP, data, &size, 0) < 0)
922 ERROR ("tcpconns plugin: netinfo failed");
927 header = (struct netinfo_header *)data;
928 nconn = header->size;
929 conn = (struct netinfo_conn *)(data + sizeof(struct netinfo_header));
931 for (i=0; i < nconn; conn++, i++)
933 conn_handle_ports (conn->srcport, conn->dstport, conn->tcp_state);
942 #endif /* KERNEL_AIX */
944 void module_register (void)
946 plugin_register_config ("tcpconns", conn_config,
947 config_keys, config_keys_num);
949 plugin_register_init ("tcpconns", conn_init);
950 #elif HAVE_SYSCTLBYNAME
951 /* no initialization */
952 #elif HAVE_LIBKVM_NLIST
953 plugin_register_init ("tcpconns", conn_init);
955 /* no initialization */
957 plugin_register_read ("tcpconns", conn_read);
958 } /* void module_register */
961 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :