[neighbour] Add nstat() function to print out neighbour table

Signed-off-by: Michael Brown <mcb30@ipxe.org>

Author: mcb30

src/include/ipxe/neighbour.h

@@ -9,7 +9,11 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
+#include <stdint.h>
+#include <ipxe/refcnt.h>
+#include <ipxe/list.h>
 #include <ipxe/netdevice.h>
+#include <ipxe/retry.h>
 
 /** A neighbour discovery protocol */
 struct neighbour_discovery {
@@ -29,6 +33,46 @@ struct neighbour_discovery {
 			       const void *net_dest, const void *net_source );
 };
 
+/** A neighbour cache entry */
+struct neighbour {
+	/** Reference count */
+	struct refcnt refcnt;
+	/** List of neighbour cache entries */
+	struct list_head list;
+
+	/** Network device */
+	struct net_device *netdev;
+	/** Network-layer protocol */
+	struct net_protocol *net_protocol;
+	/** Network-layer destination address */
+	uint8_t net_dest[MAX_NET_ADDR_LEN];
+	/** Link-layer destination address */
+	uint8_t ll_dest[MAX_LL_ADDR_LEN];
+
+	/** Neighbour discovery protocol (if any) */
+	struct neighbour_discovery *discovery;
+	/** Network-layer source address (if any) */
+	uint8_t net_source[MAX_NET_ADDR_LEN];
+	/** Retransmission timer */
+	struct retry_timer timer;
+
+	/** Pending I/O buffers */
+	struct list_head tx_queue;
+};
+
+/**
+ * Test if neighbour cache entry has a valid link-layer address
+ *
+ * @v neighbour		Neighbour cache entry
+ * @ret has_ll_dest	Neighbour cache entry has a valid link-layer address
+ */
+static inline __attribute__ (( always_inline )) int
+neighbour_has_ll_dest ( struct neighbour *neighbour ) {
+	return ( ! timer_running ( &neighbour->timer ) );
+}
+
+extern struct list_head neighbours;
+
 extern int neighbour_tx ( struct io_buffer *iobuf, struct net_device *netdev,
 			  struct net_protocol *net_protocol,
 			  const void *net_dest,

src/include/usr/neighmgmt.h

@@ -0,0 +1,14 @@
+#ifndef _USR_NEIGHMGMT_H
+#define _USR_NEIGHMGMT_H
+
+/** @file
+ *
+ * Neighbour management
+ *
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+extern void nstat ( void );
+
+#endif /* _USR_NEIGHMGMT_H */

src/net/neighbour.c

@@ -23,8 +23,6 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #include <stdlib.h>
 #include <string.h>
 #include <errno.h>
-#include <ipxe/refcnt.h>
-#include <ipxe/list.h>
 #include <ipxe/iobuf.h>
 #include <ipxe/retry.h>
 #include <ipxe/timer.h>
@@ -40,41 +38,14 @@ FILE_LICENCE ( GPL2_OR_LATER );
  *
  */
 
-/** A neighbour cache entry */
-struct neighbour {
-	/** Reference count */
-	struct refcnt refcnt;
-	/** List of neighbour cache entries */
-	struct list_head list;
-
-	/** Network device */
-	struct net_device *netdev;
-	/** Network-layer protocol */
-	struct net_protocol *net_protocol;
-	/** Network-layer destination address */
-	uint8_t net_dest[MAX_NET_ADDR_LEN];
-	/** Link-layer destination address */
-	uint8_t ll_dest[MAX_LL_ADDR_LEN];
-
-	/** Neighbour discovery protocol (if any) */
-	struct neighbour_discovery *discovery;
-	/** Network-layer source address (if any) */
-	uint8_t net_source[MAX_NET_ADDR_LEN];
-	/** Retransmission timer */
-	struct retry_timer timer;
-
-	/** Pending I/O buffers */
-	struct list_head tx_queue;
-};
-
 /** Neighbour discovery minimum timeout */
 #define NEIGHBOUR_MIN_TIMEOUT ( TICKS_PER_SEC / 8 )
 
 /** Neighbour discovery maximum timeout */
 #define NEIGHBOUR_MAX_TIMEOUT ( TICKS_PER_SEC * 3 )
 
 /** The neighbour cache */
-static LIST_HEAD ( neighbours );
+struct list_head neighbours = LIST_HEAD_INIT ( neighbours );
 
 static void neighbour_expired ( struct retry_timer *timer, int over );
 
@@ -97,17 +68,6 @@ static void neighbour_free ( struct refcnt *refcnt ) {
 	free ( neighbour );
 }
 
-/**
- * Test if neighbour cache entry has a valid link-layer address
- *
- * @v neighbour		Neighbour cache entry
- * @ret has_ll_dest	Neighbour cache entry has a valid link-layer address
- */
-static inline __attribute__ (( always_inline )) int
-neighbour_has_ll_dest ( struct neighbour *neighbour ) {
-	return ( ! timer_running ( &neighbour->timer ) );
-}
-
 /**
  * Create neighbour cache entry
  *

src/usr/neighmgmt.c

@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * 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 Free Software Foundation; either version 2 of the
+ * License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+#include <stdio.h>
+#include <ipxe/neighbour.h>
+#include <usr/neighmgmt.h>
+
+/** @file
+ *
+ * Neighbour management
+ *
+ */
+
+/**
+ * Print neighbour table
+ *
+ */
+void nstat ( void ) {
+	struct neighbour *neighbour;
+	struct net_device *netdev;
+	struct ll_protocol *ll_protocol;
+	struct net_protocol *net_protocol;
+
+	list_for_each_entry ( neighbour, &neighbours, list ) {
+		netdev = neighbour->netdev;
+		ll_protocol = netdev->ll_protocol;
+		net_protocol = neighbour->net_protocol;
+		printf ( "%s %s %s is %s %s", netdev->name, net_protocol->name,
+			 net_protocol->ntoa ( neighbour->net_dest ),
+			 ll_protocol->name,
+			 ( neighbour_has_ll_dest ( neighbour ) ?
+			   ll_protocol->ntoa ( neighbour->ll_dest ) :
+			   "(incomplete)" ) );
+		if ( neighbour->discovery )
+			printf ( " (%s)", neighbour->discovery->name );
+		printf ( "\n" );
+	}
+}