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 */
142 struct inet_diag_req r;
145 static const char *tcp_state[] =
161 # define TCP_STATE_LISTEN 10
162 # define TCP_STATE_MIN 1
163 # define TCP_STATE_MAX 11
164 /* #endif KERNEL_LINUX */
166 #elif HAVE_SYSCTLBYNAME
167 static const char *tcp_state[] =
182 # define TCP_STATE_LISTEN 1
183 # define TCP_STATE_MIN 0
184 # define TCP_STATE_MAX 10
185 /* #endif HAVE_SYSCTLBYNAME */
187 #elif HAVE_LIBKVM_NLIST
188 static const char *tcp_state[] =
204 static u_long inpcbtable_off = 0;
205 struct inpcbtable *inpcbtable_ptr = NULL;
207 # define TCP_STATE_LISTEN 1
208 # define TCP_STATE_MIN 1
209 # define TCP_STATE_MAX 10
210 /* #endif HAVE_LIBKVM_NLIST */
213 static const char *tcp_state[] =
228 # define TCP_STATE_LISTEN 1
229 # define TCP_STATE_MIN 0
230 # define TCP_STATE_MAX 10
232 struct netinfo_conn {
236 struct in6_addr dstaddr;
239 struct in6_addr srcaddr;
240 uint32_t unknow4[36];
245 struct netinfo_header {
250 # define NETINFO_TCP 3
251 extern int netinfo (int proto, void *data, int *size, int n);
252 #endif /* KERNEL_AIX */
254 #define PORT_COLLECT_LOCAL 0x01
255 #define PORT_COLLECT_REMOTE 0x02
256 #define PORT_IS_LISTENING 0x04
258 typedef struct port_entry_s
262 uint32_t count_local[TCP_STATE_MAX + 1];
263 uint32_t count_remote[TCP_STATE_MAX + 1];
264 struct port_entry_s *next;
267 static const char *config_keys[] =
273 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
275 static int port_collect_listening = 0;
276 static port_entry_t *port_list_head = NULL;
278 static void conn_submit_port_entry (port_entry_t *pe)
281 value_list_t vl = VALUE_LIST_INIT;
286 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
287 sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
288 sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
290 if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
291 || (pe->flags & PORT_COLLECT_LOCAL))
293 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
294 "%"PRIu16"-local", pe->port);
296 for (i = 1; i <= TCP_STATE_MAX; i++)
298 vl.values[0].gauge = pe->count_local[i];
300 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
302 plugin_dispatch_values (&vl);
306 if (pe->flags & PORT_COLLECT_REMOTE)
308 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
309 "%"PRIu16"-remote", pe->port);
311 for (i = 1; i <= TCP_STATE_MAX; i++)
313 vl.values[0].gauge = pe->count_remote[i];
315 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
317 plugin_dispatch_values (&vl);
320 } /* void conn_submit */
322 static void conn_submit_all (void)
326 for (pe = port_list_head; pe != NULL; pe = pe->next)
327 conn_submit_port_entry (pe);
328 } /* void conn_submit_all */
330 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
334 ret = port_list_head;
337 if (ret->port == port)
342 if ((ret == NULL) && (create != 0))
344 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
347 memset (ret, '\0', sizeof (port_entry_t));
350 ret->next = port_list_head;
351 port_list_head = ret;
355 } /* port_entry_t *conn_get_port_entry */
357 /* Removes ports that were added automatically due to the `ListeningPorts'
358 * setting but which are no longer listening. */
359 static void conn_reset_port_entry (void)
361 port_entry_t *prev = NULL;
362 port_entry_t *pe = port_list_head;
366 /* If this entry was created while reading the files (ant not when handling
367 * the configuration) remove it now. */
368 if ((pe->flags & (PORT_COLLECT_LOCAL
369 | PORT_COLLECT_REMOTE
370 | PORT_IS_LISTENING)) == 0)
372 port_entry_t *next = pe->next;
374 DEBUG ("tcpconns plugin: Removing temporary entry "
375 "for listening port %"PRIu16, pe->port);
378 port_list_head = next;
388 memset (pe->count_local, '\0', sizeof (pe->count_local));
389 memset (pe->count_remote, '\0', sizeof (pe->count_remote));
390 pe->flags &= ~PORT_IS_LISTENING;
394 } /* void conn_reset_port_entry */
396 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
398 port_entry_t *pe = NULL;
400 if ((state > TCP_STATE_MAX)
401 #if TCP_STATE_MIN > 0
402 || (state < TCP_STATE_MIN)
406 NOTICE ("tcpconns plugin: Ignoring connection with "
407 "unknown state 0x%02"PRIx8".", state);
411 /* Listening sockets */
412 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
414 pe = conn_get_port_entry (port_local, 1 /* create */);
416 pe->flags |= PORT_IS_LISTENING;
419 DEBUG ("tcpconns plugin: Connection %"PRIu16" <-> %"PRIu16" (%s)",
420 port_local, port_remote, tcp_state[state]);
422 pe = conn_get_port_entry (port_local, 0 /* no create */);
424 pe->count_local[state]++;
426 pe = conn_get_port_entry (port_remote, 0 /* no create */);
428 pe->count_remote[state]++;
431 } /* int conn_handle_ports */
434 static int conn_read_netlink (void)
437 struct sockaddr_nl nladdr;
441 struct inet_diag_msg *r;
443 static uint32_t sequence_number = 0;
445 fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_INET_DIAG);
449 memset(&nladdr, 0, sizeof(nladdr));
450 nladdr.nl_family = AF_NETLINK;
452 memset(&req, 0, sizeof(req));
453 req.nlh.nlmsg_len = sizeof(req);
454 req.nlh.nlmsg_type = TCPDIAG_GETSOCK;
455 /* NLM_F_ROOT: return the complete table instead of a single entry.
456 * NLM_F_MATCH: return all entries matching criteria (not implemented)
457 * NLM_F_REQUEST: must be set on all request messages */
458 req.nlh.nlmsg_flags = NLM_F_ROOT | NLM_F_MATCH | NLM_F_REQUEST;
459 req.nlh.nlmsg_pid = 0;
460 /* The sequence_number is used to track our messages. Since netlink is not
461 * reliable, we don't want to end up with a corrupt or incomplete old
462 * message in case the system is/was out of memory. */
463 req.nlh.nlmsg_seq = ++sequence_number;
464 req.r.idiag_family = AF_INET;
465 req.r.idiag_states = 0xfff;
468 memset(&iov, 0, sizeof(iov));
470 iov.iov_len = sizeof(req);
472 memset(&msg, 0, sizeof(msg));
473 msg.msg_name = (void*)&nladdr;
474 msg.msg_namelen = sizeof(nladdr);
478 if (sendmsg (fd, &msg, 0) < 0)
485 iov.iov_len = sizeof(buf);
492 memset(&msg, 0, sizeof(msg));
493 msg.msg_name = (void*)&nladdr;
494 msg.msg_namelen = sizeof(nladdr);
498 status = recvmsg(fd, (void *) &msg, /* flags = */ 0);
513 h = (struct nlmsghdr*)buf;
514 while (NLMSG_OK(h, status))
516 if (h->nlmsg_seq == sequence_number)
518 if (h->nlmsg_type == NLMSG_DONE)
523 else if (h->nlmsg_type == NLMSG_ERROR)
531 /* This code does not (need to) distinguish between IPv4 and IPv6. */
532 conn_handle_ports (ntohs(r->id.idiag_sport),
533 ntohs(r->id.idiag_dport),
536 h = NLMSG_NEXT(h, status);
540 /* Not reached because the while() loop above handles the exit condition. */
542 } /* int conn_read_netlink */
544 static int conn_handle_line (char *buffer)
551 char *port_local_str;
552 char *port_remote_str;
554 uint16_t port_remote;
558 int buffer_len = strlen (buffer);
560 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
561 buffer[--buffer_len] = '\0';
565 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
568 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
572 port_local_str = strchr (fields[1], ':');
573 port_remote_str = strchr (fields[2], ':');
575 if ((port_local_str == NULL) || (port_remote_str == NULL))
579 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
583 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
584 if ((endptr == NULL) || (*endptr != '\0'))
588 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
589 if ((endptr == NULL) || (*endptr != '\0'))
593 state = (uint8_t) strtol (fields[3], &endptr, 16);
594 if ((endptr == NULL) || (*endptr != '\0'))
597 return (conn_handle_ports (port_local, port_remote, state));
598 } /* int conn_handle_line */
600 static int conn_read_file (const char *file)
605 fh = fopen (file, "r");
609 while (fgets (buffer, sizeof (buffer), fh) != NULL)
611 conn_handle_line (buffer);
612 } /* while (fgets) */
617 } /* int conn_read_file */
618 /* #endif KERNEL_LINUX */
620 #elif HAVE_SYSCTLBYNAME
621 /* #endif HAVE_SYSCTLBYNAME */
623 #elif HAVE_LIBKVM_NLIST
624 #endif /* HAVE_LIBKVM_NLIST */
626 static int conn_config (const char *key, const char *value)
628 if (strcasecmp (key, "ListeningPorts") == 0)
631 port_collect_listening = 1;
633 port_collect_listening = 0;
635 else if ((strcasecmp (key, "LocalPort") == 0)
636 || (strcasecmp (key, "RemotePort") == 0))
639 int port = atoi (value);
641 if ((port < 1) || (port > 65535))
643 ERROR ("tcpconns plugin: Invalid port: %i", port);
647 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
650 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
654 if (strcasecmp (key, "LocalPort") == 0)
655 pe->flags |= PORT_COLLECT_LOCAL;
657 pe->flags |= PORT_COLLECT_REMOTE;
665 } /* int conn_config */
668 static int conn_init (void)
670 if (port_list_head == NULL)
671 port_collect_listening = 1;
674 } /* int conn_init */
676 static int conn_read (void)
680 conn_reset_port_entry ();
682 /* Try to use netlink for getting this data, it is _much_ faster on systems
683 * with a large amount of connections. */
684 if (conn_read_netlink () != 0)
686 if (conn_read_file ("/proc/net/tcp") != 0)
688 if (conn_read_file ("/proc/net/tcp6") != 0)
698 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
704 } /* int conn_read */
705 /* #endif KERNEL_LINUX */
707 #elif HAVE_SYSCTLBYNAME
708 static int conn_read (void)
714 struct xinpgen *in_orig;
715 struct xinpgen *in_ptr;
717 conn_reset_port_entry ();
720 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
723 ERROR ("tcpconns plugin: sysctlbyname failed.");
727 buffer = (char *) malloc (buffer_len);
730 ERROR ("tcpconns plugin: malloc failed.");
734 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
737 ERROR ("tcpconns plugin: sysctlbyname failed.");
742 if (buffer_len <= sizeof (struct xinpgen))
744 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
749 in_orig = (struct xinpgen *) buffer;
750 for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
751 in_ptr->xig_len > sizeof (struct xinpgen);
752 in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
754 struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
755 struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
756 struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
758 /* Ignore non-TCP sockets */
759 if (so->xso_protocol != IPPROTO_TCP)
762 /* Ignore PCBs which were freed during copyout. */
763 if (inp->inp_gencnt > in_orig->xig_gen)
766 if (((inp->inp_vflag & INP_IPV4) == 0)
767 && ((inp->inp_vflag & INP_IPV6) == 0))
770 conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
781 } /* int conn_read */
782 /* #endif HAVE_SYSCTLBYNAME */
784 #elif HAVE_LIBKVM_NLIST
785 static int kread (u_long addr, void *buf, int size)
789 status = kvm_read (kvmd, addr, buf, size);
792 ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
793 status, size, kvm_geterr (kvmd));
799 static int conn_init (void)
801 char buf[_POSIX2_LINE_MAX];
810 kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
813 ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
817 status = kvm_nlist (kvmd, nl);
820 ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
824 if (nl[N_TCBTABLE].n_type == 0)
826 ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
827 "N_TCBTABLE is invalid.");
831 inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
832 inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
835 } /* int conn_init */
837 static int conn_read (void)
839 struct inpcbtable table;
846 conn_reset_port_entry ();
848 /* Read the pcbtable from the kernel */
849 status = kread (inpcbtable_off, &table, sizeof (table));
853 /* Get the `head' pcb */
854 head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
855 /* Get the first pcb */
856 next = (struct inpcb *)CIRCLEQ_FIRST (&table.inpt_queue);
860 /* Read the pcb pointed to by `next' into `inpcb' */
861 kread ((u_long) next, &inpcb, sizeof (inpcb));
864 next = (struct inpcb *)CIRCLEQ_NEXT (&inpcb, inp_queue);
866 /* Ignore sockets, that are not connected. */
868 if (inpcb.inp_af == AF_INET6)
869 continue; /* XXX see netbsd/src/usr.bin/netstat/inet6.c */
871 if (!(inpcb.inp_flags & INP_IPV6)
872 && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
874 if ((inpcb.inp_flags & INP_IPV6)
875 && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
879 kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
880 conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
881 } /* while (next != head) */
887 /* #endif HAVE_LIBKVM_NLIST */
891 static int conn_read (void)
897 struct netinfo_header *header;
898 struct netinfo_conn *conn;
900 conn_reset_port_entry ();
902 size = netinfo(NETINFO_TCP, 0, 0, 0);
905 ERROR ("tcpconns plugin: netinfo failed return: %i", size);
912 if ((size - sizeof (struct netinfo_header)) % sizeof (struct netinfo_conn))
914 ERROR ("tcpconns plugin: invalid buffer size");
921 ERROR ("tcpconns plugin: malloc failed");
925 if (netinfo(NETINFO_TCP, data, &size, 0) < 0)
927 ERROR ("tcpconns plugin: netinfo failed");
932 header = (struct netinfo_header *)data;
933 nconn = header->size;
934 conn = (struct netinfo_conn *)(data + sizeof(struct netinfo_header));
936 for (i=0; i < nconn; conn++, i++)
938 conn_handle_ports (conn->srcport, conn->dstport, conn->tcp_state);
947 #endif /* KERNEL_AIX */
949 void module_register (void)
951 plugin_register_config ("tcpconns", conn_config,
952 config_keys, config_keys_num);
954 plugin_register_init ("tcpconns", conn_init);
955 #elif HAVE_SYSCTLBYNAME
956 /* no initialization */
957 #elif HAVE_LIBKVM_NLIST
958 plugin_register_init ("tcpconns", conn_init);
960 /* no initialization */
962 plugin_register_read ("tcpconns", conn_read);
963 } /* void module_register */
966 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :