Bump version to 4.9.4; Update ChangeLog.
[collectd.git] / src / tcpconns.c
index b31ebd8..d68cd09 100644 (file)
@@ -1,6 +1,7 @@
 /**
  * collectd - src/tcpconns.c
- * Copyright (C) 2007  Florian octo Forster
+ * Copyright (C) 2007,2008  Florian octo Forster
+ * Copyright (C) 2008       Michael Stapelberg
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
  *
  * Author:
  *   Florian octo Forster <octo at verplant.org>
+ *   Michael Stapelberg <michael+git at stapelberg.de>
  **/
 
 /**
- * Code within `__OpenBSD__' blocks is provided under the following license:
+ * Code within `HAVE_LIBKVM_NLIST' blocks is provided under the following
+ * license:
  *
  * $collectd: parts of tcpconns.c, 2008/08/08 03:48:30 Michael Stapelberg $
  * $OpenBSD: inet.c,v 1.100 2007/06/19 05:28:30 ray Exp $
 #include "common.h"
 #include "plugin.h"
 
-#if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !__OpenBSD__
+#if defined(__OpenBSD__) || defined(__NetBSD__)
+#undef HAVE_SYSCTLBYNAME /* force HAVE_LIBKVM_NLIST path */
+#endif
+
+#if !KERNEL_LINUX && !HAVE_SYSCTLBYNAME && !HAVE_LIBKVM_NLIST
 # error "No applicable input method."
 #endif
 
 # include <netinet/tcp_var.h>
 /* #endif HAVE_SYSCTLBYNAME */
 
-#elif __OpenBSD__
+/* This is for OpenBSD and NetBSD. */
+#elif HAVE_LIBKVM_NLIST
 # include <sys/queue.h>
 # include <sys/socket.h>
 # include <net/route.h>
 # include <netinet/in.h>
 # include <netinet/in_systm.h>
 # include <netinet/ip.h>
+# include <netinet/ip_var.h>
 # include <netinet/in_pcb.h>
 # include <netinet/tcp.h>
 # include <netinet/tcp_timer.h>
 # include <arpa/inet.h>
 # include <nlist.h>
 # include <kvm.h>
-#endif /* __OpenBSD__ */
+#endif /* HAVE_LIBKVM_NLIST */
 
 #if KERNEL_LINUX
 static const char *tcp_state[] =
@@ -154,118 +163,30 @@ static const char *tcp_state[] =
 # define TCP_STATE_MAX 10
 /* #endif HAVE_SYSCTLBYNAME */
 
-#elif __OpenBSD__
+#elif HAVE_LIBKVM_NLIST
 static const char *tcp_state[] =
 {
   "CLOSED",
   "LISTEN",
   "SYN_SENT",
-  "SYN_RCVD",
+  "SYN_RECV",
   "ESTABLISHED",
   "CLOSE_WAIT",
-  "FIN_WAIT_1",
+  "FIN_WAIT1",
   "CLOSING",
   "LAST_ACK",
-  "FIN_WAIT_2",
+  "FIN_WAIT2",
   "TIME_WAIT"
 };
 
 static kvm_t *kvmd;
-
-static struct nlist nl[] = {
-#define N_MBSTAT        0
-        { "_mbstat" },
-#define N_IPSTAT        1
-        { "_ipstat" },
-#define N_TCBTABLE      2
-        { "_tcbtable" },
-#define N_TCPSTAT       3
-        { "_tcpstat" },
-#define N_UDBTABLE      4
-        { "_udbtable" },
-#define N_UDPSTAT       5
-        { "_udpstat" },
-#define N_IFNET         6
-        { "_ifnet" },
-#define N_ICMPSTAT      7
-        { "_icmpstat" },
-#define N_RTSTAT        8
-        { "_rtstat" },
-#define N_UNIXSW        9
-        { "_unixsw" },
-#define N_RTREE         10
-        { "_rt_tables"},
-#define N_FILE          11
-        { "_file" },
-#define N_IGMPSTAT      12
-        { "_igmpstat" },
-#define N_MRTPROTO      13
-        { "_ip_mrtproto" },
-#define N_MRTSTAT       14
-        { "_mrtstat" },
-#define N_MFCHASHTBL    15
-        { "_mfchashtbl" },
-#define N_MFCHASH       16
-        { "_mfchash" },
-        { "_viftable" },
-#define N_AHSTAT        18
-        { "_ahstat"},
-#define N_ESPSTAT       19
-        { "_espstat"},
-#define N_IP4STAT       20
-        { "_ipipstat"},
-#define N_DDPSTAT       21
-        { "_ddpstat"},
-#define N_DDPCB         22
-        { "_ddpcb"},
-#define N_ETHERIPSTAT   23
-        { "_etheripstat"},
-#define N_IP6STAT       24
-        { "_ip6stat" },
-#define N_ICMP6STAT     25
-        { "_icmp6stat" },
-#define N_PIM6STAT      26
-        { "_pim6stat" },
-#define N_MRT6PROTO     27
-        { "_ip6_mrtproto" },
-#define N_MRT6STAT      28
-        { "_mrt6stat" },
-#define N_MF6CTABLE     29
-        { "_mf6ctable" },
-#define N_MIF6TABLE     30
-        { "_mif6table" },
-#define N_MBPOOL        31
-        { "_mbpool" },
-#define N_MCLPOOL       32
-        { "_mclpool" },
-#define N_IPCOMPSTAT    33
-        { "_ipcompstat" },
-#define N_RIP6STAT      34
-        { "_rip6stat" },
-#define N_CARPSTAT      35
-        { "_carpstats" },
-#define N_RAWIPTABLE    36
-        { "_rawcbtable" },
-#define N_RAWIP6TABLE   37
-        { "_rawin6pcbtable" },
-#define N_PFSYNCSTAT    38
-        { "_pfsyncstats" },
-#define N_PIMSTAT       39
-        { "_pimstat" },
-#define N_AF2RTAFIDX    40
-        { "_af2rtafidx" },
-#define N_RTBLIDMAX     41
-        { "_rtbl_id_max" },
-#define N_RTMASK        42
-        { "_mask_rnhead" },
-
-        { "" }
-};
+static u_long      inpcbtable_off = 0;
+struct inpcbtable *inpcbtable_ptr = NULL;
 
 # define TCP_STATE_LISTEN 1
 # define TCP_STATE_MIN 1
 # define TCP_STATE_MAX 10
-#endif /* __OpenBSD__ */
+#endif /* HAVE_LIBKVM_NLIST */
 
 #define PORT_COLLECT_LOCAL  0x01
 #define PORT_COLLECT_REMOTE 0x02
@@ -299,7 +220,6 @@ static void conn_submit_port_entry (port_entry_t *pe)
 
   vl.values = values;
   vl.values_len = 1;
-  vl.time = time (NULL);
   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
   sstrncpy (vl.plugin, "tcpconns", sizeof (vl.plugin));
   sstrncpy (vl.type, "tcp_connections", sizeof (vl.type));
@@ -308,7 +228,7 @@ static void conn_submit_port_entry (port_entry_t *pe)
       || (pe->flags & PORT_COLLECT_LOCAL))
   {
     ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
-       "%hu-local", pe->port);
+       "%"PRIu16"-local", pe->port);
 
     for (i = 1; i <= TCP_STATE_MAX; i++)
     {
@@ -323,7 +243,7 @@ static void conn_submit_port_entry (port_entry_t *pe)
   if (pe->flags & PORT_COLLECT_REMOTE)
   {
     ssnprintf (vl.plugin_instance, sizeof (vl.plugin_instance),
-       "%hu-remote", pe->port);
+       "%"PRIu16"-remote", pe->port);
 
     for (i = 1; i <= TCP_STATE_MAX; i++)
     {
@@ -389,7 +309,7 @@ static void conn_reset_port_entry (void)
       port_entry_t *next = pe->next;
 
       DEBUG ("tcpconns plugin: Removing temporary entry "
-         "for listening port %hu", pe->port);
+         "for listening port %"PRIu16, pe->port);
 
       if (prev == NULL)
        port_list_head = next;
@@ -420,8 +340,8 @@ static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t
 #endif
      )
   {
-    NOTICE ("tcpconns plugin: Ignoring connection with unknown state 0x%02x.",
-       state);
+    NOTICE ("tcpconns plugin: Ignoring connection with "
+       "unknown state 0x%02"PRIx8".", state);
     return (-1);
   }
 
@@ -433,7 +353,7 @@ static int conn_handle_ports (uint16_t port_local, uint16_t port_remote, uint8_t
       pe->flags |= PORT_IS_LISTENING;
   }
 
-  DEBUG ("tcpconns plugin: Connection %hu <-> %hu (%s)",
+  DEBUG ("tcpconns plugin: Connection %"PRIu16" <-> %"PRIu16" (%s)",
       port_local, port_remote, tcp_state[state]);
 
   pe = conn_get_port_entry (port_local, 0 /* no create */);
@@ -525,15 +445,16 @@ static int conn_read_file (const char *file)
 /* #endif KERNEL_LINUX */
 
 #elif HAVE_SYSCTLBYNAME
-#endif /* HAVE_SYSCTLBYNAME */
+/* #endif HAVE_SYSCTLBYNAME */
+
+#elif HAVE_LIBKVM_NLIST
+#endif /* HAVE_LIBKVM_NLIST */
 
 static int conn_config (const char *key, const char *value)
 {
   if (strcasecmp (key, "ListeningPorts") == 0)
   {
-    if ((strcasecmp (value, "Yes") == 0)
-       || (strcasecmp (value, "True") == 0)
-       || (strcasecmp (value, "On") == 0))
+    if (IS_TRUE (value))
       port_collect_listening = 1;
     else
       port_collect_listening = 0;
@@ -668,7 +589,8 @@ static int conn_read (void)
        && ((inp->inp_vflag & INP_IPV6) == 0))
       continue;
 
-    conn_handle_ports (inp->inp_lport, inp->inp_fport, tp->t_state);
+    conn_handle_ports (ntohs (inp->inp_lport), ntohs (inp->inp_fport),
+       tp->t_state);
   } /* for (in_ptr) */
 
   in_orig = NULL;
@@ -681,62 +603,110 @@ static int conn_read (void)
 } /* int conn_read */
 /* #endif HAVE_SYSCTLBYNAME */
 
-#elif __OpenBSD__
-static int kread(u_long addr, void *buf, int size)
+#elif HAVE_LIBKVM_NLIST
+static int kread (u_long addr, void *buf, int size)
 {
-  if (kvm_read(kvmd, addr, buf, size) != size)
+  int status;
+
+  status = kvm_read (kvmd, addr, buf, size);
+  if (status != size)
   {
-    ERROR ("tcpconns plugin: %s\n", kvm_geterr(kvmd));
+    ERROR ("tcpconns plugin: kvm_read failed (got %i, expected %i): %s\n",
+       status, size, kvm_geterr (kvmd));
     return (-1);
   }
   return (0);
-}
+} /* int kread */
 
 static int conn_init (void)
 {
   char buf[_POSIX2_LINE_MAX];
-  if ((kvmd = kvm_openfiles(NULL, NULL, NULL, O_RDONLY, buf)) == NULL)
+  struct nlist nl[] =
+  {
+#define N_TCBTABLE 0
+    { "_tcbtable" },
+    { "" }
+  };
+  int status;
+
+  kvmd = kvm_openfiles (NULL, NULL, NULL, O_RDONLY, buf);
+  if (kvmd == NULL)
+  {
+    ERROR ("tcpconns plugin: kvm_openfiles failed: %s", buf);
+    return (-1);
+  }
+
+  status = kvm_nlist (kvmd, nl);
+  if (status < 0)
   {
-    ERROR("tcpconns plugin: %s", buf);
+    ERROR ("tcpconns plugin: kvm_nlist failed with status %i.", status);
     return (-1);
   }
-  if (kvm_nlist(kvmd, nl) < 0 || nl[0].n_type == 0)
+
+  if (nl[N_TCBTABLE].n_type == 0)
   {
-    ERROR("tcpconns plugin: No namelist.");
+    ERROR ("tcpconns plugin: Error looking up kernel's namelist: "
+       "N_TCBTABLE is invalid.");
     return (-1);
   }
+
+  inpcbtable_off = (u_long) nl[N_TCBTABLE].n_value;
+  inpcbtable_ptr = (struct inpcbtable *) nl[N_TCBTABLE].n_value;
+
   return (0);
-}
+} /* int conn_init */
 
 static int conn_read (void)
 {
-  u_long off = nl[2].n_value;
   struct inpcbtable table;
-  struct inpcb *head, *next, *prev;
+  struct inpcb *head;
+  struct inpcb *next;
   struct inpcb inpcb;
   struct tcpcb tcpcb;
+  int status;
 
   conn_reset_port_entry ();
 
-  kread(off, &table, sizeof(table));
-  prev = head = (struct inpcb *)&CIRCLEQ_FIRST(&((struct inpcbtable *)off)->inpt_queue);
-  next = CIRCLEQ_FIRST(&table.inpt_queue);
+  /* Read the pcbtable from the kernel */
+  status = kread (inpcbtable_off, &table, sizeof (table));
+  if (status != 0)
+    return (-1);
+
+  /* Get the `head' pcb */
+  head = (struct inpcb *) &(inpcbtable_ptr->inpt_queue);
+  /* Get the first pcb */
+  next = (struct inpcb *)CIRCLEQ_FIRST (&table.inpt_queue);
 
-  while (next != head) {
-    kread((u_long)next, &inpcb, sizeof(inpcb));
-    prev = next;
-    next = CIRCLEQ_NEXT(&inpcb, inp_queue);
-    if (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY)
+  while (next != head)
+  {
+    /* Read the pcb pointed to by `next' into `inpcb' */
+    kread ((u_long) next, &inpcb, sizeof (inpcb));
+
+    /* Advance `next' */
+    next = (struct inpcb *)CIRCLEQ_NEXT (&inpcb, inp_queue);
+
+    /* Ignore sockets, that are not connected. */
+#ifdef __NetBSD__
+    if (inpcb.inp_af == AF_INET6)
+      continue; /* XXX see netbsd/src/usr.bin/netstat/inet6.c */
+#else
+    if (!(inpcb.inp_flags & INP_IPV6)
+       && (inet_lnaof(inpcb.inp_laddr) == INADDR_ANY))
       continue;
-    kread((u_long)inpcb.inp_ppcb, &tcpcb, sizeof(tcpcb));
+    if ((inpcb.inp_flags & INP_IPV6)
+       && IN6_IS_ADDR_UNSPECIFIED (&inpcb.inp_laddr6))
+      continue;
+#endif
+
+    kread ((u_long) inpcb.inp_ppcb, &tcpcb, sizeof (tcpcb));
     conn_handle_ports (ntohs(inpcb.inp_lport), ntohs(inpcb.inp_fport), tcpcb.t_state);
-  }
+  } /* while (next != head) */
 
   conn_submit_all ();
 
   return (0);
 }
-#endif /* __OpenBSD__ */
+#endif /* HAVE_LIBKVM_NLIST */
 
 void module_register (void)
 {
@@ -746,12 +716,12 @@ void module_register (void)
        plugin_register_init ("tcpconns", conn_init);
 #elif HAVE_SYSCTLBYNAME
        /* no initialization */
-#elif __OpenBSD__
+#elif HAVE_LIBKVM_NLIST
        plugin_register_init ("tcpconns", conn_init);
 #endif
        plugin_register_read ("tcpconns", conn_read);
 } /* void module_register */
 
 /*
- * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :
+ * vim: set shiftwidth=2 softtabstop=2 tabstop=8 fdm=marker :
  */