2 * collectd - src/tcpconns.c
3 * Copyright (C) 2007 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
23 * Code within `__OpenBSD__' blocks is provided under the following license:
25 * $collectd: parts of tcpconns.c, 2008/08/08 03:48:30 Michael Stapelberg $
26 * $OpenBSD: inet.c,v 1.100 2007/06/19 05:28:30 ray Exp $
27 * $NetBSD: inet.c,v 1.14 1995/10/03 21:42:37 thorpej Exp $
29 * Copyright (c) 1983, 1988, 1993
30 * The Regents of the University of California. All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. Neither the name of the University nor the names of its contributors
41 * may be used to endorse or promote products derived from this software
42 * without specific prior written permission.
44 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 #if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !__OpenBSD__
62 # error "No applicable input method."
66 /* #endif KERNEL_LINUX */
68 #elif HAVE_SYSCTLBYNAME
69 # include <sys/socketvar.h>
70 # include <sys/sysctl.h>
72 /* Some includes needed for compiling on FreeBSD */
75 # include <sys/types.h>
78 # include <sys/socket.h>
84 # include <net/route.h>
85 # include <netinet/in.h>
86 # include <netinet/in_systm.h>
87 # include <netinet/ip.h>
88 # include <netinet/ip6.h>
89 # include <netinet/in_pcb.h>
90 # include <netinet/ip_var.h>
91 # include <netinet/tcp.h>
92 # include <netinet/tcpip.h>
93 # include <netinet/tcp_seq.h>
94 # include <netinet/tcp_var.h>
95 /* #endif HAVE_SYSCTLBYNAME */
98 # include <sys/queue.h>
99 # include <sys/socket.h>
100 # include <net/route.h>
101 # include <netinet/in.h>
102 # include <netinet/in_systm.h>
103 # include <netinet/ip.h>
104 # include <netinet/in_pcb.h>
105 # include <netinet/tcp.h>
106 # include <netinet/tcp_timer.h>
107 # include <netinet/tcp_var.h>
109 # include <arpa/inet.h>
112 #endif /* __OpenBSD__ */
115 static const char *tcp_state[] =
131 # define TCP_STATE_LISTEN 10
132 # define TCP_STATE_MIN 1
133 # define TCP_STATE_MAX 11
134 /* #endif KERNEL_LINUX */
136 #elif HAVE_SYSCTLBYNAME
137 static const char *tcp_state[] =
152 # define TCP_STATE_LISTEN 1
153 # define TCP_STATE_MIN 0
154 # define TCP_STATE_MAX 10
155 /* #endif HAVE_SYSCTLBYNAME */
158 static const char *tcp_state[] =
175 static struct nlist nl[] = {
200 #define N_IGMPSTAT 12
202 #define N_MRTPROTO 13
206 #define N_MFCHASHTBL 15
221 #define N_ETHERIPSTAT 23
225 #define N_ICMP6STAT 25
227 #define N_PIM6STAT 26
229 #define N_MRT6PROTO 27
231 #define N_MRT6STAT 28
233 #define N_MF6CTABLE 29
235 #define N_MIF6TABLE 30
241 #define N_IPCOMPSTAT 33
243 #define N_RIP6STAT 34
245 #define N_CARPSTAT 35
247 #define N_RAWIPTABLE 36
249 #define N_RAWIP6TABLE 37
250 { "_rawin6pcbtable" },
251 #define N_PFSYNCSTAT 38
255 #define N_AF2RTAFIDX 40
257 #define N_RTBLIDMAX 41
265 # define TCP_STATE_LISTEN 1
266 # define TCP_STATE_MIN 1
267 # define TCP_STATE_MAX 10
268 #endif /* __OpenBSD__ */
270 #define PORT_COLLECT_LOCAL 0x01
271 #define PORT_COLLECT_REMOTE 0x02
272 #define PORT_IS_LISTENING 0x04
274 typedef struct port_entry_s
278 uint32_t count_local[TCP_STATE_MAX + 1];
279 uint32_t count_remote[TCP_STATE_MAX + 1];
280 struct port_entry_s *next;
283 static const char *config_keys[] =
289 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
291 static int port_collect_listening = 0;
292 static port_entry_t *port_list_head = NULL;
294 static void conn_submit_port_entry (port_entry_t *pe)
297 value_list_t vl = VALUE_LIST_INIT;
302 vl.time = time (NULL);
303 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
304 sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
305 sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
307 if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
308 || (pe->flags & PORT_COLLECT_LOCAL))
310 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
311 "%hu-local", pe->port);
313 for (i = 1; i <= TCP_STATE_MAX; i++)
315 vl.values[0].gauge = pe->count_local[i];
317 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
319 plugin_dispatch_values (&vl);
323 if (pe->flags & PORT_COLLECT_REMOTE)
325 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
326 "%hu-remote", pe->port);
328 for (i = 1; i <= TCP_STATE_MAX; i++)
330 vl.values[0].gauge = pe->count_remote[i];
332 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
334 plugin_dispatch_values (&vl);
337 } /* void conn_submit */
339 static void conn_submit_all (void)
343 for (pe = port_list_head; pe != NULL; pe = pe->next)
344 conn_submit_port_entry (pe);
345 } /* void conn_submit_all */
347 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
351 ret = port_list_head;
354 if (ret->port == port)
359 if ((ret == NULL) && (create != 0))
361 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
364 memset (ret, '\0', sizeof (port_entry_t));
367 ret->next = port_list_head;
368 port_list_head = ret;
372 } /* port_entry_t *conn_get_port_entry */
374 /* Removes ports that were added automatically due to the `ListeningPorts'
375 * setting but which are no longer listening. */
376 static void conn_reset_port_entry (void)
378 port_entry_t *prev = NULL;
379 port_entry_t *pe = port_list_head;
383 /* If this entry was created while reading the files (ant not when handling
384 * the configuration) remove it now. */
385 if ((pe->flags & (PORT_COLLECT_LOCAL
386 | PORT_COLLECT_REMOTE
387 | PORT_IS_LISTENING)) == 0)
389 port_entry_t *next = pe->next;
391 DEBUG ("tcpconns plugin: Removing temporary entry "
392 "for listening port %hu", pe->port);
395 port_list_head = next;
405 memset (pe->count_local, '\0', sizeof (pe->count_local));
406 memset (pe->count_remote, '\0', sizeof (pe->count_remote));
407 pe->flags &= ~PORT_IS_LISTENING;
411 } /* void conn_reset_port_entry */
413 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
415 port_entry_t *pe = NULL;
417 if ((state > TCP_STATE_MAX)
418 #if TCP_STATE_MIN > 0
419 || (state < TCP_STATE_MIN)
423 NOTICE ("tcpconns plugin: Ignoring connection with unknown state 0x%02x.",
428 /* Listening sockets */
429 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
431 pe = conn_get_port_entry (port_local, 1 /* create */);
433 pe->flags |= PORT_IS_LISTENING;
436 DEBUG ("tcpconns plugin: Connection %hu <-> %hu (%s)",
437 port_local, port_remote, tcp_state[state]);
439 pe = conn_get_port_entry (port_local, 0 /* no create */);
441 pe->count_local[state]++;
443 pe = conn_get_port_entry (port_remote, 0 /* no create */);
445 pe->count_remote[state]++;
448 } /* int conn_handle_ports */
451 static int conn_handle_line (char *buffer)
458 char *port_local_str;
459 char *port_remote_str;
461 uint16_t port_remote;
465 int buffer_len = strlen (buffer);
467 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
468 buffer[--buffer_len] = '\0';
472 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
475 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
479 port_local_str = strchr (fields[1], ':');
480 port_remote_str = strchr (fields[2], ':');
482 if ((port_local_str == NULL) || (port_remote_str == NULL))
486 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
490 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
491 if ((endptr == NULL) || (*endptr != '\0'))
495 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
496 if ((endptr == NULL) || (*endptr != '\0'))
500 state = (uint8_t) strtol (fields[3], &endptr, 16);
501 if ((endptr == NULL) || (*endptr != '\0'))
504 return (conn_handle_ports (port_local, port_remote, state));
505 } /* int conn_handle_line */
507 static int conn_read_file (const char *file)
512 fh = fopen (file, "r");
516 while (fgets (buffer, sizeof (buffer), fh) != NULL)
518 conn_handle_line (buffer);
519 } /* while (fgets) */
524 } /* int conn_read_file */
525 /* #endif KERNEL_LINUX */
527 #elif HAVE_SYSCTLBYNAME
528 #endif /* HAVE_SYSCTLBYNAME */
530 static int conn_config (const char *key, const char *value)
532 if (strcasecmp (key, "ListeningPorts") == 0)
534 if ((strcasecmp (value, "Yes") == 0)
535 || (strcasecmp (value, "True") == 0)
536 || (strcasecmp (value, "On") == 0))
537 port_collect_listening = 1;
539 port_collect_listening = 0;
541 else if ((strcasecmp (key, "LocalPort") == 0)
542 || (strcasecmp (key, "RemotePort") == 0))
545 int port = atoi (value);
547 if ((port < 1) || (port > 65535))
549 ERROR ("tcpconns plugin: Invalid port: %i", port);
553 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
556 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
560 if (strcasecmp (key, "LocalPort") == 0)
561 pe->flags |= PORT_COLLECT_LOCAL;
563 pe->flags |= PORT_COLLECT_REMOTE;
571 } /* int conn_config */
574 static int conn_init (void)
576 if (port_list_head == NULL)
577 port_collect_listening = 1;
580 } /* int conn_init */
582 static int conn_read (void)
586 conn_reset_port_entry ();
588 if (conn_read_file ("/proc/net/tcp") != 0)
590 if (conn_read_file ("/proc/net/tcp6") != 0)
599 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
605 } /* int conn_read */
606 /* #endif KERNEL_LINUX */
608 #elif HAVE_SYSCTLBYNAME
609 static int conn_read (void)
615 struct xinpgen *in_orig;
616 struct xinpgen *in_ptr;
618 conn_reset_port_entry ();
621 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
624 ERROR ("tcpconns plugin: sysctlbyname failed.");
628 buffer = (char *) malloc (buffer_len);
631 ERROR ("tcpconns plugin: malloc failed.");
635 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
638 ERROR ("tcpconns plugin: sysctlbyname failed.");
643 if (buffer_len <= sizeof (struct xinpgen))
645 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
650 in_orig = (struct xinpgen *) buffer;
651 for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
652 in_ptr->xig_len > sizeof (struct xinpgen);
653 in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
655 struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
656 struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
657 struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
659 /* Ignore non-TCP sockets */
660 if (so->xso_protocol != IPPROTO_TCP)
663 /* Ignore PCBs which were freed during copyout. */
664 if (inp->inp_gencnt > in_orig->xig_gen)
667 if (((inp->inp_vflag & INP_IPV4) == 0)
668 && ((inp->inp_vflag & INP_IPV6) == 0))
671 conn_handle_ports (inp->inp_lport, inp->inp_fport, tp->t_state);
681 } /* int conn_read */
682 /* #endif HAVE_SYSCTLBYNAME */
685 static int kread(u_long addr, void *buf, int size)
687 if (kvm_read(kvmd, addr, buf, size) != size)
689 ERROR ("tcpconns plugin: %s\n", kvm_geterr(kvmd));
695 static int conn_init (void)
697 char buf[_POSIX2_LINE_MAX];
698 if ((kvmd = kvm_openfiles(NULL, NULL, NULL, O_RDONLY, buf)) == NULL)
700 ERROR("tcpconns plugin: %s", buf);
703 if (kvm_nlist(kvmd, nl) < 0 || nl[0].n_type == 0)
705 ERROR("tcpconns plugin: No namelist.");
711 static int conn_read (void)
713 u_long off = nl[2].n_value;
714 struct inpcbtable table;
715 struct inpcb *head, *next, *prev;
719 conn_reset_port_entry ();
721 kread(off, &table, sizeof(table));
722 prev = head = (struct inpcb *)&CIRCLEQ_FIRST(&((struct inpcbtable *)off)->inpt_queue);
723 next = CIRCLEQ_FIRST(&table.inpt_queue);
725 while (next != head) {
726 kread((u_long)next, &inpcb, sizeof(inpcb));
728 next = CIRCLEQ_NEXT(&inpcb, inp_queue);
729 if (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY)
731 kread((u_long)inpcb.inp_ppcb, &tcpcb, sizeof(tcpcb));
732 conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
739 #endif /* __OpenBSD__ */
741 void module_register (void)
743 plugin_register_config ("tcpconns", conn_config,
744 config_keys, config_keys_num);
746 plugin_register_init ("tcpconns", conn_init);
747 #elif HAVE_SYSCTLBYNAME
748 /* no initialization */
750 plugin_register_init ("tcpconns", conn_init);
752 plugin_register_read ("tcpconns", conn_read);
753 } /* void module_register */
756 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :