Code

collectd-nagios: Implement the "-m" option (treat NaNs as critical).
[collectd.git] / src / tcpconns.c
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 defined(__OpenBSD__) || defined(__NetBSD__)
65 #undef HAVE_SYSCTLBYNAME /* force HAVE_LIBKVM_NLIST path */
66 #endif
68 #if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !HAVE_LIBKVM_NLIST
69 # error "No applicable input method."
70 #endif
72 #if KERNEL_LINUX
73 /* #endif KERNEL_LINUX */
75 #elif HAVE_SYSCTLBYNAME
76 # include <sys/socketvar.h>
77 # include <sys/sysctl.h>
79 /* Some includes needed for compiling on FreeBSD */
80 #include <sys/time.h>
81 #if HAVE_SYS_TYPES_H
82 # include <sys/types.h>
83 #endif
84 #if HAVE_SYS_SOCKET_H
85 # include <sys/socket.h>
86 #endif
87 #if HAVE_NET_IF_H
88 # include <net/if.h>
89 #endif
91 # include <net/route.h>
92 # include <netinet/in.h>
93 # include <netinet/in_systm.h>
94 # include <netinet/ip.h>
95 # include <netinet/ip6.h>
96 # include <netinet/in_pcb.h>
97 # include <netinet/ip_var.h>
98 # include <netinet/tcp.h>
99 # include <netinet/tcpip.h>
100 # include <netinet/tcp_seq.h>
101 # include <netinet/tcp_var.h>
102 /* #endif HAVE_SYSCTLBYNAME */
104 /* This is for OpenBSD and NetBSD. */
105 #elif HAVE_LIBKVM_NLIST
106 # include <sys/queue.h>
107 # include <sys/socket.h>
108 # include <net/route.h>
109 # include <netinet/in.h>
110 # include <netinet/in_systm.h>
111 # include <netinet/ip.h>
112 # include <netinet/ip_var.h>
113 # include <netinet/in_pcb.h>
114 # include <netinet/tcp.h>
115 # include <netinet/tcp_timer.h>
116 # include <netinet/tcp_var.h>
117 # include <netdb.h>
118 # include <arpa/inet.h>
119 # include <nlist.h>
120 # include <kvm.h>
121 #endif /* HAVE_LIBKVM_NLIST */
123 #if KERNEL_LINUX
124 static const char *tcp_state[] =
126   "", /* 0 */
127   "ESTABLISHED",
128   "SYN_SENT",
129   "SYN_RECV",
130   "FIN_WAIT1",
131   "FIN_WAIT2",
132   "TIME_WAIT",
133   "CLOSED",
134   "CLOSE_WAIT",
135   "LAST_ACK",
136   "LISTEN", /* 10 */
137   "CLOSING"
138 };
140 # define TCP_STATE_LISTEN 10
141 # define TCP_STATE_MIN 1
142 # define TCP_STATE_MAX 11
143 /* #endif KERNEL_LINUX */
145 #elif HAVE_SYSCTLBYNAME
146 static const char *tcp_state[] =
148   "CLOSED",
149   "LISTEN",
150   "SYN_SENT",
151   "SYN_RECV",
152   "ESTABLISHED",
153   "CLOSE_WAIT",
154   "FIN_WAIT1",
155   "CLOSING",
156   "LAST_ACK",
157   "FIN_WAIT2",
158   "TIME_WAIT"
159 };
161 # define TCP_STATE_LISTEN 1
162 # define TCP_STATE_MIN 0
163 # define TCP_STATE_MAX 10
164 /* #endif HAVE_SYSCTLBYNAME */
166 #elif HAVE_LIBKVM_NLIST
167 static const char *tcp_state[] =
169   "CLOSED",
170   "LISTEN",
171   "SYN_SENT",
172   "SYN_RECV",
173   "ESTABLISHED",
174   "CLOSE_WAIT",
175   "FIN_WAIT1",
176   "CLOSING",
177   "LAST_ACK",
178   "FIN_WAIT2",
179   "TIME_WAIT"
180 };
182 static kvm_t *kvmd;
183 static u_long      inpcbtable_off = 0;
184 struct inpcbtable *inpcbtable_ptr = NULL;
186 # define TCP_STATE_LISTEN 1
187 # define TCP_STATE_MIN 1
188 # define TCP_STATE_MAX 10
189 #endif /* HAVE_LIBKVM_NLIST */
191 #define PORT_COLLECT_LOCAL  0x01
192 #define PORT_COLLECT_REMOTE 0x02
193 #define PORT_IS_LISTENING   0x04
195 typedef struct port_entry_s
197   uint16_t port;
198   uint16_t flags;
199   uint32_t count_local[TCP_STATE_MAX + 1];
200   uint32_t count_remote[TCP_STATE_MAX + 1];
201   struct port_entry_s *next;
202 } port_entry_t;
204 static const char *config_keys[] =
206   "ListeningPorts",
207   "LocalPort",
208   "RemotePort"
209 };
210 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
212 static int port_collect_listening = 0;
213 static port_entry_t *port_list_head = NULL;
215 static void conn_submit_port_entry (port_entry_t *pe)
217   value_t values[1];
218   value_list_t vl = VALUE_LIST_INIT;
219   int i;
221   vl.values = values;
222   vl.values_len = 1;
223   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
224   sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
225   sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
227   if (((port_collect_listening != 0) && (pe->flags & PORT_IS_LISTENING))
228       || (pe->flags & PORT_COLLECT_LOCAL))
229   {
230     ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
231         "%"PRIu16"-local", pe->port);
233     for (i = 1; i <= TCP_STATE_MAX; i++)
234     {
235       vl.values[0].gauge = pe->count_local[i];
237       sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
239       plugin_dispatch_values (&vl);
240     }
241   }
243   if (pe->flags & PORT_COLLECT_REMOTE)
244   {
245     ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
246         "%"PRIu16"-remote", pe->port);
248     for (i = 1; i <= TCP_STATE_MAX; i++)
249     {
250       vl.values[0].gauge = pe->count_remote[i];
252       sstrncpy (vl.type_instance, tcp_state[i], sizeof (vl.type_instance));
254       plugin_dispatch_values (&vl);
255     }
256   }
257 } /* void conn_submit */
259 static void conn_submit_all (void)
261   port_entry_t *pe;
263   for (pe = port_list_head; pe != NULL; pe = pe->next)
264     conn_submit_port_entry (pe);
265 } /* void conn_submit_all */
267 static port_entry_t *conn_get_port_entry (uint16_t port, int create)
269   port_entry_t *ret;
271   ret = port_list_head;
272   while (ret != NULL)
273   {
274     if (ret->port == port)
275       break;
276     ret = ret->next;
277   }
279   if ((ret == NULL) && (create != 0))
280   {
281     ret = (port_entry_t *) malloc (sizeof (port_entry_t));
282     if (ret == NULL)
283       return (NULL);
284     memset (ret, '\0', sizeof (port_entry_t));
286     ret->port = port;
287     ret->next = port_list_head;
288     port_list_head = ret;
289   }
291   return (ret);
292 } /* port_entry_t *conn_get_port_entry */
294 /* Removes ports that were added automatically due to the `ListeningPorts'
295  * setting but which are no longer listening. */
296 static void conn_reset_port_entry (void)
298   port_entry_t *prev = NULL;
299   port_entry_t *pe = port_list_head;
301   while (pe != NULL)
302   {
303     /* If this entry was created while reading the files (ant not when handling
304      * the configuration) remove it now. */
305     if ((pe->flags & (PORT_COLLECT_LOCAL
306             | PORT_COLLECT_REMOTE
307             | PORT_IS_LISTENING)) == 0)
308     {
309       port_entry_t *next = pe->next;
311       DEBUG ("tcpconns plugin: Removing temporary entry "
312           "for listening port %"PRIu16, pe->port);
314       if (prev == NULL)
315         port_list_head = next;
316       else
317         prev->next = next;
319       sfree (pe);
320       pe = next;
322       continue;
323     }
325     memset (pe->count_local, '\0', sizeof (pe->count_local));
326     memset (pe->count_remote, '\0', sizeof (pe->count_remote));
327     pe->flags &= ~PORT_IS_LISTENING;
329     pe = pe->next;
330   }
331 } /* void conn_reset_port_entry */
333 static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t state)
335   port_entry_t *pe = NULL;
337   if ((state > TCP_STATE_MAX)
338 #if TCP_STATE_MIN > 0
339       || (state < TCP_STATE_MIN)
340 #endif
341      )
342   {
343     NOTICE ("tcpconns plugin: Ignoring connection with "
344         "unknown state 0x%02"PRIx8".", state);
345     return (-1);
346   }
348   /* Listening sockets */
349   if ((state == TCP_STATE_LISTEN) && (port_collect_listening != 0))
350   {
351     pe = conn_get_port_entry (port_local, 1 /* create */);
352     if (pe != NULL)
353       pe->flags |= PORT_IS_LISTENING;
354   }
356   DEBUG ("tcpconns plugin: Connection %"PRIu16" <-> %"PRIu16" (%s)",
357       port_local, port_remote, tcp_state[state]);
359   pe = conn_get_port_entry (port_local, 0 /* no create */);
360   if (pe != NULL)
361     pe->count_local[state]++;
363   pe = conn_get_port_entry (port_remote, 0 /* no create */);
364   if (pe != NULL)
365     pe->count_remote[state]++;
367   return (0);
368 } /* int conn_handle_ports */
370 #if KERNEL_LINUX
371 static int conn_handle_line (char *buffer)
373   char *fields[32];
374   int   fields_len;
376   char *endptr;
378   char *port_local_str;
379   char *port_remote_str;
380   uint16_t port_local;
381   uint16_t port_remote;
383   uint8_t state;
385   int buffer_len = strlen (buffer);
387   while ((buffer_len > 0) && (buffer[buffer_len - 1] < 32))
388     buffer[--buffer_len] = '\0';
389   if (buffer_len <= 0)
390     return (-1);
392   fields_len = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
393   if (fields_len < 12)
394   {
395     DEBUG ("tcpconns plugin: Got %i fields, expected at least 12.", fields_len);
396     return (-1);
397   }
399   port_local_str  = strchr (fields[1], ':');
400   port_remote_str = strchr (fields[2], ':');
402   if ((port_local_str == NULL) || (port_remote_str == NULL))
403     return (-1);
404   port_local_str++;
405   port_remote_str++;
406   if ((*port_local_str == '\0') || (*port_remote_str == '\0'))
407     return (-1);
409   endptr = NULL;
410   port_local = (uint16_t) strtol (port_local_str, &endptr, 16);
411   if ((endptr == NULL) || (*endptr != '\0'))
412     return (-1);
414   endptr = NULL;
415   port_remote = (uint16_t) strtol (port_remote_str, &endptr, 16);
416   if ((endptr == NULL) || (*endptr != '\0'))
417     return (-1);
419   endptr = NULL;
420   state = (uint8_t) strtol (fields[3], &endptr, 16);
421   if ((endptr == NULL) || (*endptr != '\0'))
422     return (-1);
424   return (conn_handle_ports (port_local, port_remote, state));
425 } /* int conn_handle_line */
427 static int conn_read_file (const char *file)
429   FILE *fh;
430   char buffer[1024];
432   fh = fopen (file, "r");
433   if (fh == NULL)
434     return (-1);
436   while (fgets (buffer, sizeof (buffer), fh) != NULL)
437   {
438     conn_handle_line (buffer);
439   } /* while (fgets) */
441   fclose (fh);
443   return (0);
444 } /* int conn_read_file */
445 /* #endif KERNEL_LINUX */
447 #elif HAVE_SYSCTLBYNAME
448 /* #endif HAVE_SYSCTLBYNAME */
450 #elif HAVE_LIBKVM_NLIST
451 #endif /* HAVE_LIBKVM_NLIST */
453 static int conn_config (const char *key, const char *value)
455   if (strcasecmp (key, "ListeningPorts") == 0)
456   {
457     if (IS_TRUE (value))
458       port_collect_listening = 1;
459     else
460       port_collect_listening = 0;
461   }
462   else if ((strcasecmp (key, "LocalPort") == 0)
463       || (strcasecmp (key, "RemotePort") == 0))
464   {
465       port_entry_t *pe;
466       int port = atoi (value);
468       if ((port < 1) || (port > 65535))
469       {
470         ERROR ("tcpconns plugin: Invalid port: %i", port);
471         return (1);
472       }
474       pe = conn_get_port_entry ((uint16_t) port, 1 /* create */);
475       if (pe == NULL)
476       {
477         ERROR ("tcpconns plugin: conn_get_port_entry failed.");
478         return (1);
479       }
481       if (strcasecmp (key, "LocalPort") == 0)
482         pe->flags |= PORT_COLLECT_LOCAL;
483       else
484         pe->flags |= PORT_COLLECT_REMOTE;
485   }
486   else
487   {
488     return (-1);
489   }
491   return (0);
492 } /* int conn_config */
494 #if KERNEL_LINUX
495 static int conn_init (void)
497   if (port_list_head == NULL)
498     port_collect_listening = 1;
500   return (0);
501 } /* int conn_init */
503 static int conn_read (void)
505   int errors_num = 0;
507   conn_reset_port_entry ();
509   if (conn_read_file ("/proc/net/tcp") != 0)
510     errors_num++;
511   if (conn_read_file ("/proc/net/tcp6") != 0)
512     errors_num++;
514   if (errors_num < 2)
515   {
516     conn_submit_all ();
517   }
518   else
519   {
520     ERROR ("tcpconns plugin: Neither /proc/net/tcp nor /proc/net/tcp6 "
521         "coult be read.");
522     return (-1);
523   }
525   return (0);
526 } /* int conn_read */
527 /* #endif KERNEL_LINUX */
529 #elif HAVE_SYSCTLBYNAME
530 static int conn_read (void)
532   int status;
533   char *buffer;
534   size_t buffer_len;;
536   struct xinpgen *in_orig;
537   struct xinpgen *in_ptr;
539   conn_reset_port_entry ();
541   buffer_len = 0;
542   status = sysctlbyname ("net.inet.tcp.pcblist", NULL, &buffer_len, 0, 0);
543   if (status < 0)
544   {
545     ERROR ("tcpconns plugin: sysctlbyname failed.");
546     return (-1);
547   }
549   buffer = (char *) malloc (buffer_len);
550   if (buffer == NULL)
551   {
552     ERROR ("tcpconns plugin: malloc failed.");
553     return (-1);
554   }
556   status = sysctlbyname ("net.inet.tcp.pcblist", buffer, &buffer_len, 0, 0);
557   if (status < 0)
558   {
559     ERROR ("tcpconns plugin: sysctlbyname failed.");
560     sfree (buffer);
561     return (-1);
562   }
564   if (buffer_len <= sizeof (struct xinpgen))
565   {
566     ERROR ("tcpconns plugin: (buffer_len <= sizeof (struct xinpgen))");
567     sfree (buffer);
568     return (-1);
569   }
571   in_orig = (struct xinpgen *) buffer;
572   for (in_ptr = (struct xinpgen *) (((char *) in_orig) + in_orig->xig_len);
573       in_ptr->xig_len > sizeof (struct xinpgen);
574       in_ptr = (struct xinpgen *) (((char *) in_ptr) + in_ptr->xig_len))
575   {
576     struct tcpcb *tp = &((struct xtcpcb *) in_ptr)->xt_tp;
577     struct inpcb *inp = &((struct xtcpcb *) in_ptr)->xt_inp;
578     struct xsocket *so = &((struct xtcpcb *) in_ptr)->xt_socket;
580     /* Ignore non-TCP sockets */
581     if (so->xso_protocol != IPPROTO_TCP)
582       continue;
584     /* Ignore PCBs which were freed during copyout. */
585     if (inp->inp_gencnt > in_orig->xig_gen)
586       continue;
588     if (((inp->inp_vflag & INP_IPV4) == 0)
589         && ((inp->inp_vflag & INP_IPV6) == 0))
590       continue;
592     conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
593         tp->t_state);
594   } /* for (in_ptr) */
596   in_orig = NULL;
597   in_ptr = NULL;
598   sfree (buffer);
600   conn_submit_all ();
602   return (0);
603 } /* int conn_read */
604 /* #endif HAVE_SYSCTLBYNAME */
606 #elif HAVE_LIBKVM_NLIST
607 static int kread (u_long addr, void *buf, int size)
609   int status;
611   status = kvm_read (kvmd, addr, buf, size);
612   if (status != size)
613   {
614     ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
615         status, size, kvm_geterr (kvmd));
616     return (-1);
617   }
618   return (0);
619 } /* int kread */
621 static int conn_init (void)
623   char buf[_POSIX2_LINE_MAX];
624   struct nlist nl[] =
625   {
626 #define N_TCBTABLE 0
627     { "_tcbtable" },
628     { "" }
629   };
630   int status;
632   kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
633   if (kvmd == NULL)
634   {
635     ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
636     return (-1);
637   }
639   status = kvm_nlist (kvmd, nl);
640   if (status < 0)
641   {
642     ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
643     return (-1);
644   }
646   if (nl[N_TCBTABLE].n_type == 0)
647   {
648     ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
649         "N_TCBTABLE is invalid.");
650     return (-1);
651   }
653   inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
654   inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
656   return (0);
657 } /* int conn_init */
659 static int conn_read (void)
661   struct inpcbtable table;
662   struct inpcb *head;
663   struct inpcb *next;
664   struct inpcb inpcb;
665   struct tcpcb tcpcb;
666   int status;
668   conn_reset_port_entry ();
670   /* Read the pcbtable from the kernel */
671   status = kread (inpcbtable_off, &table, sizeof (table));
672   if (status != 0)
673     return (-1);
675   /* Get the `head' pcb */
676   head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
677   /* Get the first pcb */
678   next = (struct inpcb *)CIRCLEQ_FIRST (&table.inpt_queue);
680   while (next != head)
681   {
682     /* Read the pcb pointed to by `next' into `inpcb' */
683     kread ((u_long) next, &inpcb, sizeof (inpcb));
685     /* Advance `next' */
686     next = (struct inpcb *)CIRCLEQ_NEXT (&inpcb, inp_queue);
688     /* Ignore sockets, that are not connected. */
689 #ifdef __NetBSD__
690     if (inpcb.inp_af == AF_INET6)
691       continue; /* XXX see netbsd/src/usr.bin/netstat/inet6.c */
692 #else
693     if (!(inpcb.inp_flags & INP_IPV6)
694         && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
695       continue;
696     if ((inpcb.inp_flags & INP_IPV6)
697         && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
698       continue;
699 #endif
701     kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
702     conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
703   } /* while (next != head) */
705   conn_submit_all ();
707   return (0);
709 #endif /* HAVE_LIBKVM_NLIST */
711 void module_register (void)
713         plugin_register_config ("tcpconns", conn_config,
714                         config_keys, config_keys_num);
715 #if KERNEL_LINUX
716         plugin_register_init ("tcpconns", conn_init);
717 #elif HAVE_SYSCTLBYNAME
718         /* no initialization */
719 #elif HAVE_LIBKVM_NLIST
720         plugin_register_init ("tcpconns", conn_init);
721 #endif
722         plugin_register_read ("tcpconns", conn_read);
723 } /* void module_register */
725 /*
726  * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :
727  */