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 !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !HAVE_LIBKVM_NLIST
65 # error "No applicable input method."
69 /* #endif KERNEL_LINUX */
71 #elif HAVE_SYSCTLBYNAME
72 # include <sys/socketvar.h>
73 # include <sys/sysctl.h>
75 /* Some includes needed for compiling on FreeBSD */
78 # include <sys/types.h>
81 # include <sys/socket.h>
87 # include <net/route.h>
88 # include <netinet/in.h>
89 # include <netinet/in_systm.h>
90 # include <netinet/ip.h>
91 # include <netinet/ip6.h>
92 # include <netinet/in_pcb.h>
93 # include <netinet/ip_var.h>
94 # include <netinet/tcp.h>
95 # include <netinet/tcpip.h>
96 # include <netinet/tcp_seq.h>
97 # include <netinet/tcp_var.h>
98 /* #endif HAVE_SYSCTLBYNAME */
100 /* This is for OpenBSD and possibly NetBSD. */
101 #elif HAVE_LIBKVM_NLIST
102 # include <sys/queue.h>
103 # include <sys/socket.h>
104 # include <net/route.h>
105 # include <netinet/in.h>
106 # include <netinet/in_systm.h>
107 # include <netinet/ip.h>
108 # include <netinet/in_pcb.h>
109 # include <netinet/tcp.h>
110 # include <netinet/tcp_timer.h>
111 # include <netinet/tcp_var.h>
113 # include <arpa/inet.h>
116 #endif /* HAVE_LIBKVM_NLIST */
119 static const char *tcp_state[] =
135 # define TCP_STATE_LISTEN 10
136 # define TCP_STATE_MIN 1
137 # define TCP_STATE_MAX 11
138 /* #endif KERNEL_LINUX */
140 #elif HAVE_SYSCTLBYNAME
141 static const char *tcp_state[] =
156 # define TCP_STATE_LISTEN 1
157 # define TCP_STATE_MIN 0
158 # define TCP_STATE_MAX 10
159 /* #endif HAVE_SYSCTLBYNAME */
161 #elif HAVE_LIBKVM_NLIST
162 static const char *tcp_state[] =
178 static u_long inpcbtable_off = 0;
179 struct inpcbtable *inpcbtable_ptr = NULL;
181 # define TCP_STATE_LISTEN 1
182 # define TCP_STATE_MIN 1
183 # define TCP_STATE_MAX 10
184 #endif /* HAVE_LIBKVM_NLIST */
186 #define PORT_COLLECT_LOCAL 0x01
187 #define PORT_COLLECT_REMOTE 0x02
188 #define PORT_IS_LISTENING 0x04
190 typedef struct port_entry_s
194 uint32_t count_local[TCP_STATE_MAX + 1];
195 uint32_t count_remote[TCP_STATE_MAX + 1];
196 struct port_entry_s *next;
199 static const char *config_keys[] =
205 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
207 static int port_collect_listening = 0;
208 static port_entry_t *port_list_head = NULL;
210 static void conn_submit_port_entry (port_entry_t *pe)
213 value_list_t vl = VALUE_LIST_INIT;
218 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
219 sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
220 sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
222 if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
223 || (pe->flags & PORT_COLLECT_LOCAL))
225 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
226 "%"PRIu16"-local", pe->port);
228 for (i = 1; i <= TCP_STATE_MAX; i++)
230 vl.values[0].gauge = pe->count_local[i];
232 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
234 plugin_dispatch_values (&vl);
238 if (pe->flags & PORT_COLLECT_REMOTE)
240 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
241 "%"PRIu16"-remote", pe->port);
243 for (i = 1; i <= TCP_STATE_MAX; i++)
245 vl.values[0].gauge = pe->count_remote[i];
247 sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
249 plugin_dispatch_values (&vl);
252 } /* void conn_submit */
254 static void conn_submit_all (void)
258 for (pe = port_list_head; pe != NULL; pe = pe->next)
259 conn_submit_port_entry (pe);
260 } /* void conn_submit_all */
262 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
266 ret = port_list_head;
269 if (ret->port == port)
274 if ((ret == NULL) && (create != 0))
276 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
279 memset (ret, '\0', sizeof (port_entry_t));
282 ret->next = port_list_head;
283 port_list_head = ret;
287 } /* port_entry_t *conn_get_port_entry */
289 /* Removes ports that were added automatically due to the `ListeningPorts'
290 * setting but which are no longer listening. */
291 static void conn_reset_port_entry (void)
293 port_entry_t *prev = NULL;
294 port_entry_t *pe = port_list_head;
298 /* If this entry was created while reading the files (ant not when handling
299 * the configuration) remove it now. */
300 if ((pe->flags & (PORT_COLLECT_LOCAL
301 | PORT_COLLECT_REMOTE
302 | PORT_IS_LISTENING)) == 0)
304 port_entry_t *next = pe->next;
306 DEBUG ("tcpconns plugin: Removing temporary entry "
307 "for listening port %"PRIu16, pe->port);
310 port_list_head = next;
320 memset (pe->count_local, '\0', sizeof (pe->count_local));
321 memset (pe->count_remote, '\0', sizeof (pe->count_remote));
322 pe->flags &= ~PORT_IS_LISTENING;
326 } /* void conn_reset_port_entry */
328 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
330 port_entry_t *pe = NULL;
332 if ((state > TCP_STATE_MAX)
333 #if TCP_STATE_MIN > 0
334 || (state < TCP_STATE_MIN)
338 NOTICE ("tcpconns plugin: Ignoring connection with "
339 "unknown state 0x%02"PRIx8".", state);
343 /* Listening sockets */
344 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
346 pe = conn_get_port_entry (port_local, 1 /* create */);
348 pe->flags |= PORT_IS_LISTENING;
351 DEBUG ("tcpconns plugin: Connection %"PRIu16" <-> %"PRIu16" (%s)",
352 port_local, port_remote, tcp_state[state]);
354 pe = conn_get_port_entry (port_local, 0 /* no create */);
356 pe->count_local[state]++;
358 pe = conn_get_port_entry (port_remote, 0 /* no create */);
360 pe->count_remote[state]++;
363 } /* int conn_handle_ports */
366 static int conn_handle_line (char *buffer)
373 char *port_local_str;
374 char *port_remote_str;
376 uint16_t port_remote;
380 int buffer_len = strlen (buffer);
382 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
383 buffer[--buffer_len] = '\0';
387 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
390 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
394 port_local_str = strchr (fields[1], ':');
395 port_remote_str = strchr (fields[2], ':');
397 if ((port_local_str == NULL) || (port_remote_str == NULL))
401 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
405 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
406 if ((endptr == NULL) || (*endptr != '\0'))
410 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
411 if ((endptr == NULL) || (*endptr != '\0'))
415 state = (uint8_t) strtol (fields[3], &endptr, 16);
416 if ((endptr == NULL) || (*endptr != '\0'))
419 return (conn_handle_ports (port_local, port_remote, state));
420 } /* int conn_handle_line */
422 static int conn_read_file (const char *file)
427 fh = fopen (file, "r");
431 while (fgets (buffer, sizeof (buffer), fh) != NULL)
433 conn_handle_line (buffer);
434 } /* while (fgets) */
439 } /* int conn_read_file */
440 /* #endif KERNEL_LINUX */
442 #elif HAVE_SYSCTLBYNAME
443 /* #endif HAVE_SYSCTLBYNAME */
445 #elif HAVE_LIBKVM_NLIST
446 #endif /* HAVE_LIBKVM_NLIST */
448 static int conn_config (const char *key, const char *value)
450 if (strcasecmp (key, "ListeningPorts") == 0)
452 if ((strcasecmp (value, "Yes") == 0)
453 || (strcasecmp (value, "True") == 0)
454 || (strcasecmp (value, "On") == 0))
455 port_collect_listening = 1;
457 port_collect_listening = 0;
459 else if ((strcasecmp (key, "LocalPort") == 0)
460 || (strcasecmp (key, "RemotePort") == 0))
463 int port = atoi (value);
465 if ((port < 1) || (port > 65535))
467 ERROR ("tcpconns plugin: Invalid port: %i", port);
471 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
474 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
478 if (strcasecmp (key, "LocalPort") == 0)
479 pe->flags |= PORT_COLLECT_LOCAL;
481 pe->flags |= PORT_COLLECT_REMOTE;
489 } /* int conn_config */
492 static int conn_init (void)
494 if (port_list_head == NULL)
495 port_collect_listening = 1;
498 } /* int conn_init */
500 static int conn_read (void)
504 conn_reset_port_entry ();
506 if (conn_read_file ("/proc/net/tcp") != 0)
508 if (conn_read_file ("/proc/net/tcp6") != 0)
517 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
523 } /* int conn_read */
524 /* #endif KERNEL_LINUX */
526 #elif HAVE_SYSCTLBYNAME
527 static int conn_read (void)
533 struct xinpgen *in_orig;
534 struct xinpgen *in_ptr;
536 conn_reset_port_entry ();
539 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
542 ERROR ("tcpconns plugin: sysctlbyname failed.");
546 buffer = (char *) malloc (buffer_len);
549 ERROR ("tcpconns plugin: malloc failed.");
553 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
556 ERROR ("tcpconns plugin: sysctlbyname failed.");
561 if (buffer_len <= sizeof (struct xinpgen))
563 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
568 in_orig = (struct xinpgen *) buffer;
569 for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
570 in_ptr->xig_len > sizeof (struct xinpgen);
571 in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
573 struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
574 struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
575 struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
577 /* Ignore non-TCP sockets */
578 if (so->xso_protocol != IPPROTO_TCP)
581 /* Ignore PCBs which were freed during copyout. */
582 if (inp->inp_gencnt > in_orig->xig_gen)
585 if (((inp->inp_vflag & INP_IPV4) == 0)
586 && ((inp->inp_vflag & INP_IPV6) == 0))
589 conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
600 } /* int conn_read */
601 /* #endif HAVE_SYSCTLBYNAME */
603 #elif HAVE_LIBKVM_NLIST
604 static int kread (u_long addr, void *buf, int size)
608 status = kvm_read (kvmd, addr, buf, size);
611 ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
612 status, size, kvm_geterr (kvmd));
618 static int conn_init (void)
620 char buf[_POSIX2_LINE_MAX];
629 kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
632 ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
636 status = kvm_nlist (kvmd, nl);
639 ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
643 if (nl[N_TCBTABLE].n_type == 0)
645 ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
646 "N_TCBTABLE is invalid.");
650 inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
651 inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
654 } /* int conn_init */
656 static int conn_read (void)
658 struct inpcbtable table;
665 conn_reset_port_entry ();
667 /* Read the pcbtable from the kernel */
668 status = kread (inpcbtable_off, &table, sizeof (table));
672 /* Get the `head' pcb */
673 head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
674 /* Get the first pcb */
675 next = CIRCLEQ_FIRST (&table.inpt_queue);
679 /* Read the pcb pointed to by `next' into `inpcb' */
680 kread ((u_long) next, &inpcb, sizeof (inpcb));
683 next = CIRCLEQ_NEXT (&inpcb, inp_queue);
685 /* Ignore sockets, that are not connected. */
686 if (!(inpcb.inp_flags & INP_IPV6)
687 && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
689 if ((inpcb.inp_flags & INP_IPV6)
690 && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
693 kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
694 conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
695 } /* while (next != head) */
701 #endif /* HAVE_LIBKVM_NLIST */
703 void module_register (void)
705 plugin_register_config ("tcpconns", conn_config,
706 config_keys, config_keys_num);
708 plugin_register_init ("tcpconns", conn_init);
709 #elif HAVE_SYSCTLBYNAME
710 /* no initialization */
711 #elif HAVE_LIBKVM_NLIST
712 plugin_register_init ("tcpconns", conn_init);
714 plugin_register_read ("tcpconns", conn_read);
715 } /* void module_register */
718 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :