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[] =
174 static u_long inpcbtable_off = 0;
175 struct inpcbtable *inpcbtable_ptr = NULL;
177 # define TCP_STATE_LISTEN 1
178 # define TCP_STATE_MIN 1
179 # define TCP_STATE_MAX 10
180 #endif /* __OpenBSD__ */
182 #define PORT_COLLECT_LOCAL 0x01
183 #define PORT_COLLECT_REMOTE 0x02
184 #define PORT_IS_LISTENING 0x04
186 typedef struct port_entry_s
190 uint32_t count_local[TCP_STATE_MAX + 1];
191 uint32_t count_remote[TCP_STATE_MAX + 1];
192 struct port_entry_s *next;
195 static const char *config_keys[] =
201 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
203 static int port_collect_listening = 0;
204 static port_entry_t *port_list_head = NULL;
206 static void conn_submit_port_entry (port_entry_t *pe)
209 value_list_t vl = VALUE_LIST_INIT;
214 vl.time = time (NULL);
215 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
216 sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
217 sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
219 if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
220 || (pe->flags & PORT_COLLECT_LOCAL))
222 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
223 "%hu-local", pe->port);
225 for (i = 1; i <= TCP_STATE_MAX; i++)
227 vl.values[0].gauge = pe->count_local[i];
229 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
231 plugin_dispatch_values (&vl);
235 if (pe->flags & PORT_COLLECT_REMOTE)
237 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
238 "%hu-remote", pe->port);
240 for (i = 1; i <= TCP_STATE_MAX; i++)
242 vl.values[0].gauge = pe->count_remote[i];
244 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
246 plugin_dispatch_values (&vl);
249 } /* void conn_submit */
251 static void conn_submit_all (void)
255 for (pe = port_list_head; pe != NULL; pe = pe->next)
256 conn_submit_port_entry (pe);
257 } /* void conn_submit_all */
259 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
263 ret = port_list_head;
266 if (ret->port == port)
271 if ((ret == NULL) && (create != 0))
273 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
276 memset (ret, '\0', sizeof (port_entry_t));
279 ret->next = port_list_head;
280 port_list_head = ret;
284 } /* port_entry_t *conn_get_port_entry */
286 /* Removes ports that were added automatically due to the `ListeningPorts'
287 * setting but which are no longer listening. */
288 static void conn_reset_port_entry (void)
290 port_entry_t *prev = NULL;
291 port_entry_t *pe = port_list_head;
295 /* If this entry was created while reading the files (ant not when handling
296 * the configuration) remove it now. */
297 if ((pe->flags & (PORT_COLLECT_LOCAL
298 | PORT_COLLECT_REMOTE
299 | PORT_IS_LISTENING)) == 0)
301 port_entry_t *next = pe->next;
303 DEBUG ("tcpconns plugin: Removing temporary entry "
304 "for listening port %hu", pe->port);
307 port_list_head = next;
317 memset (pe->count_local, '\0', sizeof (pe->count_local));
318 memset (pe->count_remote, '\0', sizeof (pe->count_remote));
319 pe->flags &= ~PORT_IS_LISTENING;
323 } /* void conn_reset_port_entry */
325 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
327 port_entry_t *pe = NULL;
329 if ((state > TCP_STATE_MAX)
330 #if TCP_STATE_MIN > 0
331 || (state < TCP_STATE_MIN)
335 NOTICE ("tcpconns plugin: Ignoring connection with unknown state 0x%02x.",
340 /* Listening sockets */
341 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
343 pe = conn_get_port_entry (port_local, 1 /* create */);
345 pe->flags |= PORT_IS_LISTENING;
348 DEBUG ("tcpconns plugin: Connection %hu <-> %hu (%s)",
349 port_local, port_remote, tcp_state[state]);
351 pe = conn_get_port_entry (port_local, 0 /* no create */);
353 pe->count_local[state]++;
355 pe = conn_get_port_entry (port_remote, 0 /* no create */);
357 pe->count_remote[state]++;
360 } /* int conn_handle_ports */
363 static int conn_handle_line (char *buffer)
370 char *port_local_str;
371 char *port_remote_str;
373 uint16_t port_remote;
377 int buffer_len = strlen (buffer);
379 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
380 buffer[--buffer_len] = '\0';
384 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
387 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
391 port_local_str = strchr (fields[1], ':');
392 port_remote_str = strchr (fields[2], ':');
394 if ((port_local_str == NULL) || (port_remote_str == NULL))
398 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
402 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
403 if ((endptr == NULL) || (*endptr != '\0'))
407 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
408 if ((endptr == NULL) || (*endptr != '\0'))
412 state = (uint8_t) strtol (fields[3], &endptr, 16);
413 if ((endptr == NULL) || (*endptr != '\0'))
416 return (conn_handle_ports (port_local, port_remote, state));
417 } /* int conn_handle_line */
419 static int conn_read_file (const char *file)
424 fh = fopen (file, "r");
428 while (fgets (buffer, sizeof (buffer), fh) != NULL)
430 conn_handle_line (buffer);
431 } /* while (fgets) */
436 } /* int conn_read_file */
437 /* #endif KERNEL_LINUX */
439 #elif HAVE_SYSCTLBYNAME
440 /* #endif HAVE_SYSCTLBYNAME */
443 #endif /* __OpenBSD__ */
445 static int conn_config (const char *key, const char *value)
447 if (strcasecmp (key, "ListeningPorts") == 0)
449 if ((strcasecmp (value, "Yes") == 0)
450 || (strcasecmp (value, "True") == 0)
451 || (strcasecmp (value, "On") == 0))
452 port_collect_listening = 1;
454 port_collect_listening = 0;
456 else if ((strcasecmp (key, "LocalPort") == 0)
457 || (strcasecmp (key, "RemotePort") == 0))
460 int port = atoi (value);
462 if ((port < 1) || (port > 65535))
464 ERROR ("tcpconns plugin: Invalid port: %i", port);
468 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
471 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
475 if (strcasecmp (key, "LocalPort") == 0)
476 pe->flags |= PORT_COLLECT_LOCAL;
478 pe->flags |= PORT_COLLECT_REMOTE;
486 } /* int conn_config */
489 static int conn_init (void)
491 if (port_list_head == NULL)
492 port_collect_listening = 1;
495 } /* int conn_init */
497 static int conn_read (void)
501 conn_reset_port_entry ();
503 if (conn_read_file ("/proc/net/tcp") != 0)
505 if (conn_read_file ("/proc/net/tcp6") != 0)
514 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
520 } /* int conn_read */
521 /* #endif KERNEL_LINUX */
523 #elif HAVE_SYSCTLBYNAME
524 static int conn_read (void)
530 struct xinpgen *in_orig;
531 struct xinpgen *in_ptr;
533 conn_reset_port_entry ();
536 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
539 ERROR ("tcpconns plugin: sysctlbyname failed.");
543 buffer = (char *) malloc (buffer_len);
546 ERROR ("tcpconns plugin: malloc failed.");
550 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
553 ERROR ("tcpconns plugin: sysctlbyname failed.");
558 if (buffer_len <= sizeof (struct xinpgen))
560 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
565 in_orig = (struct xinpgen *) buffer;
566 for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
567 in_ptr->xig_len > sizeof (struct xinpgen);
568 in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
570 struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
571 struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
572 struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
574 /* Ignore non-TCP sockets */
575 if (so->xso_protocol != IPPROTO_TCP)
578 /* Ignore PCBs which were freed during copyout. */
579 if (inp->inp_gencnt > in_orig->xig_gen)
582 if (((inp->inp_vflag & INP_IPV4) == 0)
583 && ((inp->inp_vflag & INP_IPV6) == 0))
586 conn_handle_ports (inp->inp_lport, inp->inp_fport, tp->t_state);
596 } /* int conn_read */
597 /* #endif HAVE_SYSCTLBYNAME */
600 static int kread (u_long addr, void *buf, int size)
604 status = kvm_read (kvmd, addr, buf, size);
607 ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
608 status, size, kvm_geterr (kvmd));
614 static int conn_init (void)
616 char buf[_POSIX2_LINE_MAX];
625 kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
628 ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
632 status = kvm_nlist (kvmd, nl);
635 ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
639 if (nl[N_TCBTABLE].n_type == 0)
641 ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
642 "N_TCBTABLE is invalid.");
646 inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
647 inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
650 } /* int conn_init */
652 static int conn_read (void)
654 struct inpcbtable table;
661 conn_reset_port_entry ();
663 /* Read the pcbtable from the kernel */
664 status = kread (inpcbtable_off, &table, sizeof (table));
668 /* Get the `head' pcb */
669 head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
670 /* Get the first pcb */
671 next = CIRCLEQ_FIRST (&table.inpt_queue);
675 /* Read the pcb pointed to by `next' into `inpcb' */
676 kread ((u_long) next, &inpcb, sizeof (inpcb));
679 next = CIRCLEQ_NEXT (&inpcb, inp_queue);
681 /* Ignore sockets, that are not connected. */
682 if (!(inpcb.inp_flags & INP_IPV6)
683 && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
685 if ((inpcb.inp_flags & INP_IPV6)
686 && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
689 kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
690 conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
691 } /* while (next != head) */
697 #endif /* __OpenBSD__ */
699 void module_register (void)
701 plugin_register_config ("tcpconns", conn_config,
702 config_keys, config_keys_num);
704 plugin_register_init ("tcpconns", conn_init);
705 #elif HAVE_SYSCTLBYNAME
706 /* no initialization */
708 plugin_register_init ("tcpconns", conn_init);
710 plugin_register_read ("tcpconns", conn_read);
711 } /* void module_register */
714 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :