1 /**
2 * collectd - src/tcpconns.c
3 * Copyright (C) 2007,2008 Florian octo Forster
4 * Copyright (C) 2008 Michael Stapelberg
5 *
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.
9 *
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.
14 *
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
18 *
19 * Author:
20 * Florian octo Forster <octo at verplant.org>
21 * Michael Stapelberg <michael+git at stapelberg.de>
22 **/
24 /**
25 * Code within `HAVE_LIBKVM_NLIST' blocks is provided under the following
26 * license:
27 *
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 $
31 *
32 * Copyright (c) 1983, 1988, 1993
33 * The Regents of the University of California. All rights reserved.
34 *
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
37 * are met:
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.
46 *
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
57 * SUCH DAMAGE.
58 */
60 #include "collectd.h"
61 #include "common.h"
62 #include "plugin.h"
64 #if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !HAVE_LIBKVM_NLIST
65 # error "No applicable input method."
66 #endif
68 #if KERNEL_LINUX
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 */
76 #include <sys/time.h>
77 #if HAVE_SYS_TYPES_H
78 # include <sys/types.h>
79 #endif
80 #if HAVE_SYS_SOCKET_H
81 # include <sys/socket.h>
82 #endif
83 #if HAVE_NET_IF_H
84 # include <net/if.h>
85 #endif
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>
112 # include <netdb.h>
113 # include <arpa/inet.h>
114 # include <nlist.h>
115 # include <kvm.h>
116 #endif /* HAVE_LIBKVM_NLIST */
118 #if KERNEL_LINUX
119 static const char *tcp_state[] =
120 {
121 "", /* 0 */
122 "ESTABLISHED",
123 "SYN_SENT",
124 "SYN_RECV",
125 "FIN_WAIT1",
126 "FIN_WAIT2",
127 "TIME_WAIT",
128 "CLOSED",
129 "CLOSE_WAIT",
130 "LAST_ACK",
131 "LISTEN", /* 10 */
132 "CLOSING"
133 };
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[] =
142 {
143 "CLOSED",
144 "LISTEN",
145 "SYN_SENT",
146 "SYN_RECV",
147 "ESTABLISHED",
148 "CLOSE_WAIT",
149 "FIN_WAIT1",
150 "CLOSING",
151 "LAST_ACK",
152 "FIN_WAIT2",
153 "TIME_WAIT"
154 };
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[] =
163 {
164 "CLOSED",
165 "LISTEN",
166 "SYN_SENT",
167 "SYN_RECV",
168 "ESTABLISHED",
169 "CLOSE_WAIT",
170 "FIN_WAIT1",
171 "CLOSING",
172 "LAST_ACK",
173 "FIN_WAIT2",
174 "TIME_WAIT"
175 };
177 static kvm_t *kvmd;
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
191 {
192 uint16_t port;
193 uint16_t flags;
194 uint32_t count_local[TCP_STATE_MAX + 1];
195 uint32_t count_remote[TCP_STATE_MAX + 1];
196 struct port_entry_s *next;
197 } port_entry_t;
199 static const char *config_keys[] =
200 {
201 "ListeningPorts",
202 "LocalPort",
203 "RemotePort"
204 };
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)
211 {
212 value_t values[1];
213 value_list_t vl = VALUE_LIST_INIT;
214 int i;
216 vl.values = values;
217 vl.values_len = 1;
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))
224 {
225 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
226 "%"PRIu16"-local", pe->port);
228 for (i = 1; i <= TCP_STATE_MAX; i++)
229 {
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);
235 }
236 }
238 if (pe->flags & PORT_COLLECT_REMOTE)
239 {
240 ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
241 "%"PRIu16"-remote", pe->port);
243 for (i = 1; i <= TCP_STATE_MAX; i++)
244 {
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);
250 }
251 }
252 } /* void conn_submit */
254 static void conn_submit_all (void)
255 {
256 port_entry_t *pe;
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)
263 {
264 port_entry_t *ret;
266 ret = port_list_head;
267 while (ret != NULL)
268 {
269 if (ret->port == port)
270 break;
271 ret = ret->next;
272 }
274 if ((ret == NULL) && (create != 0))
275 {
276 ret = (port_entry_t *) malloc (sizeof (port_entry_t));
277 if (ret == NULL)
278 return (NULL);
279 memset (ret, '\0', sizeof (port_entry_t));
281 ret->port = port;
282 ret->next = port_list_head;
283 port_list_head = ret;
284 }
286 return (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)
292 {
293 port_entry_t *prev = NULL;
294 port_entry_t *pe = port_list_head;
296 while (pe != NULL)
297 {
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)
303 {
304 port_entry_t *next = pe->next;
306 DEBUG ("tcpconns plugin: Removing temporary entry "
307 "for listening port %"PRIu16, pe->port);
309 if (prev == NULL)
310 port_list_head = next;
311 else
312 prev->next = next;
314 sfree (pe);
315 pe = next;
317 continue;
318 }
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;
324 pe = pe->next;
325 }
326 } /* void conn_reset_port_entry */
328 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
329 {
330 port_entry_t *pe = NULL;
332 if ((state > TCP_STATE_MAX)
333 #if TCP_STATE_MIN > 0
334 || (state < TCP_STATE_MIN)
335 #endif
336 )
337 {
338 NOTICE ("tcpconns plugin: Ignoring connection with "
339 "unknown state 0x%02"PRIx8".", state);
340 return (-1);
341 }
343 /* Listening sockets */
344 if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
345 {
346 pe = conn_get_port_entry (port_local, 1 /* create */);
347 if (pe != NULL)
348 pe->flags |= PORT_IS_LISTENING;
349 }
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 */);
355 if (pe != NULL)
356 pe->count_local[state]++;
358 pe = conn_get_port_entry (port_remote, 0 /* no create */);
359 if (pe != NULL)
360 pe->count_remote[state]++;
362 return (0);
363 } /* int conn_handle_ports */
365 #if KERNEL_LINUX
366 static int conn_handle_line (char *buffer)
367 {
368 char *fields[32];
369 int fields_len;
371 char *endptr;
373 char *port_local_str;
374 char *port_remote_str;
375 uint16_t port_local;
376 uint16_t port_remote;
378 uint8_t state;
380 int buffer_len = strlen (buffer);
382 while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
383 buffer[--buffer_len] = '\0';
384 if (buffer_len <= 0)
385 return (-1);
387 fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
388 if (fields_len < 12)
389 {
390 DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
391 return (-1);
392 }
394 port_local_str = strchr (fields[1], ':');
395 port_remote_str = strchr (fields[2], ':');
397 if ((port_local_str == NULL) || (port_remote_str == NULL))
398 return (-1);
399 port_local_str++;
400 port_remote_str++;
401 if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
402 return (-1);
404 endptr = NULL;
405 port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
406 if ((endptr == NULL) || (*endptr != '\0'))
407 return (-1);
409 endptr = NULL;
410 port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
411 if ((endptr == NULL) || (*endptr != '\0'))
412 return (-1);
414 endptr = NULL;
415 state = (uint8_t) strtol (fields[3], &endptr, 16);
416 if ((endptr == NULL) || (*endptr != '\0'))
417 return (-1);
419 return (conn_handle_ports (port_local, port_remote, state));
420 } /* int conn_handle_line */
422 static int conn_read_file (const char *file)
423 {
424 FILE *fh;
425 char buffer[1024];
427 fh = fopen (file, "r");
428 if (fh == NULL)
429 return (-1);
431 while (fgets (buffer, sizeof (buffer), fh) != NULL)
432 {
433 conn_handle_line (buffer);
434 } /* while (fgets) */
436 fclose (fh);
438 return (0);
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)
449 {
450 if (strcasecmp (key, "ListeningPorts") == 0)
451 {
452 if ((strcasecmp (value, "Yes") == 0)
453 || (strcasecmp (value, "True") == 0)
454 || (strcasecmp (value, "On") == 0))
455 port_collect_listening = 1;
456 else
457 port_collect_listening = 0;
458 }
459 else if ((strcasecmp (key, "LocalPort") == 0)
460 || (strcasecmp (key, "RemotePort") == 0))
461 {
462 port_entry_t *pe;
463 int port = atoi (value);
465 if ((port < 1) || (port > 65535))
466 {
467 ERROR ("tcpconns plugin: Invalid port: %i", port);
468 return (1);
469 }
471 pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
472 if (pe == NULL)
473 {
474 ERROR ("tcpconns plugin: conn_get_port_entry failed.");
475 return (1);
476 }
478 if (strcasecmp (key, "LocalPort") == 0)
479 pe->flags |= PORT_COLLECT_LOCAL;
480 else
481 pe->flags |= PORT_COLLECT_REMOTE;
482 }
483 else
484 {
485 return (-1);
486 }
488 return (0);
489 } /* int conn_config */
491 #if KERNEL_LINUX
492 static int conn_init (void)
493 {
494 if (port_list_head == NULL)
495 port_collect_listening = 1;
497 return (0);
498 } /* int conn_init */
500 static int conn_read (void)
501 {
502 int errors_num = 0;
504 conn_reset_port_entry ();
506 if (conn_read_file ("/proc/net/tcp") != 0)
507 errors_num++;
508 if (conn_read_file ("/proc/net/tcp6") != 0)
509 errors_num++;
511 if (errors_num < 2)
512 {
513 conn_submit_all ();
514 }
515 else
516 {
517 ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
518 "coult be read.");
519 return (-1);
520 }
522 return (0);
523 } /* int conn_read */
524 /* #endif KERNEL_LINUX */
526 #elif HAVE_SYSCTLBYNAME
527 static int conn_read (void)
528 {
529 int status;
530 char *buffer;
531 size_t buffer_len;;
533 struct xinpgen *in_orig;
534 struct xinpgen *in_ptr;
536 conn_reset_port_entry ();
538 buffer_len = 0;
539 status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
540 if (status < 0)
541 {
542 ERROR ("tcpconns plugin: sysctlbyname failed.");
543 return (-1);
544 }
546 buffer = (char *) malloc (buffer_len);
547 if (buffer == NULL)
548 {
549 ERROR ("tcpconns plugin: malloc failed.");
550 return (-1);
551 }
553 status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
554 if (status < 0)
555 {
556 ERROR ("tcpconns plugin: sysctlbyname failed.");
557 sfree (buffer);
558 return (-1);
559 }
561 if (buffer_len <= sizeof (struct xinpgen))
562 {
563 ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
564 sfree (buffer);
565 return (-1);
566 }
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))
572 {
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)
579 continue;
581 /* Ignore PCBs which were freed during copyout. */
582 if (inp->inp_gencnt > in_orig->xig_gen)
583 continue;
585 if (((inp->inp_vflag & INP_IPV4) == 0)
586 && ((inp->inp_vflag & INP_IPV6) == 0))
587 continue;
589 conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
590 tp->t_state);
591 } /* for (in_ptr) */
593 in_orig = NULL;
594 in_ptr = NULL;
595 sfree (buffer);
597 conn_submit_all ();
599 return (0);
600 } /* int conn_read */
601 /* #endif HAVE_SYSCTLBYNAME */
603 #elif HAVE_LIBKVM_NLIST
604 static int kread (u_long addr, void *buf, int size)
605 {
606 int status;
608 status = kvm_read (kvmd, addr, buf, size);
609 if (status != size)
610 {
611 ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
612 status, size, kvm_geterr (kvmd));
613 return (-1);
614 }
615 return (0);
616 } /* int kread */
618 static int conn_init (void)
619 {
620 char buf[_POSIX2_LINE_MAX];
621 struct nlist nl[] =
622 {
623 #define N_TCBTABLE 0
624 { "_tcbtable" },
625 { "" }
626 };
627 int status;
629 kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
630 if (kvmd == NULL)
631 {
632 ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
633 return (-1);
634 }
636 status = kvm_nlist (kvmd, nl);
637 if (status < 0)
638 {
639 ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
640 return (-1);
641 }
643 if (nl[N_TCBTABLE].n_type == 0)
644 {
645 ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
646 "N_TCBTABLE is invalid.");
647 return (-1);
648 }
650 inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
651 inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
653 return (0);
654 } /* int conn_init */
656 static int conn_read (void)
657 {
658 struct inpcbtable table;
659 struct inpcb *head;
660 struct inpcb *next;
661 struct inpcb inpcb;
662 struct tcpcb tcpcb;
663 int status;
665 conn_reset_port_entry ();
667 /* Read the pcbtable from the kernel */
668 status = kread (inpcbtable_off, &table, sizeof (table));
669 if (status != 0)
670 return (-1);
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);
677 while (next != head)
678 {
679 /* Read the pcb pointed to by `next' into `inpcb' */
680 kread ((u_long) next, &inpcb, sizeof (inpcb));
682 /* Advance `next' */
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))
688 continue;
689 if ((inpcb.inp_flags & INP_IPV6)
690 && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
691 continue;
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) */
697 conn_submit_all ();
699 return (0);
700 }
701 #endif /* HAVE_LIBKVM_NLIST */
703 void module_register (void)
704 {
705 plugin_register_config ("tcpconns", conn_config,
706 config_keys, config_keys_num);
707 #if KERNEL_LINUX
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);
713 #endif
714 plugin_register_read ("tcpconns", conn_read);
715 } /* void module_register */
717 /*
718 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :
719 */