[list] Add list_first_entry()

There are several points in the iPXE codebase where
list_for_each_entry() is (ab)used to extract only the first entry from
a list.  Add a macro list_first_entry() to make this code easier to
read.

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

7 files changed, 41 insertions, 28 deletions

diff --git a/src/core/process.c b/src/core/process.c
index bc070e06..a3297856 100644
--- a/src/core/process.c
+++ b/src/core/process.c
@@ -83,7 +83,8 @@ void process_del ( struct process *process ) {
 void step ( void ) {
 	struct process *process;
 
-	list_for_each_entry ( process, &run_queue, list ) {
+	if ( ( process = list_first_entry ( &run_queue, struct process,
+					    list ) ) ) {
 		list_del ( &process->list );
 		list_add_tail ( &process->list, &run_queue );
 		ref_get ( process->refcnt ); /* Inhibit destruction mid-step */
@@ -93,7 +94,6 @@ void step ( void ) {
 		DBGC2 ( process, "PROCESS %p (%p) finished executing\n",
 			process, process->step );
 		ref_put ( process->refcnt ); /* Allow destruction */
-		break;
 	}
 }
 
diff --git a/src/hci/commands/fcmgmt_cmd.c b/src/hci/commands/fcmgmt_cmd.c
index 3a4e2846..98647c13 100644
--- a/src/hci/commands/fcmgmt_cmd.c
+++ b/src/hci/commands/fcmgmt_cmd.c
@@ -144,12 +144,11 @@ static int fcels_exec ( int argc, char **argv ) {
 		}
 	} else {
 		/* Use first port */
-		if ( list_empty ( &fc_ports ) ) {
+		port = list_first_entry ( &fc_ports, struct fc_port, list );
+		if ( ! port ) {
 			printf ( "No ports\n" );
 			return 1;
 		}
-		list_for_each_entry ( port, &fc_ports, list )
-			break;
 	}
 	assert ( port != NULL );
 
diff --git a/src/include/ipxe/list.h b/src/include/ipxe/list.h
index fb00bc53..ab4c119d 100644
--- a/src/include/ipxe/list.h
+++ b/src/include/ipxe/list.h
@@ -158,6 +158,19 @@ static inline int list_empty ( const struct list_head *list ) {
 	container_of ( list, type, member ); } )
 
 /**
+ * Get the container of the first entry in a list
+ *
+ * @v list		List head
+ * @v type		Containing type
+ * @v member		Name of list field within containing type
+ * @ret first		First list entry, or NULL
+ */
+#define list_first_entry( list, type, member )		\
+	( list_empty ( (list) ) ?			\
+	  ( type * ) NULL :				\
+	  list_entry ( (list)->next, type, member ) )
+
+/**
  * Iterate over entries in a list
  *
  * @v pos		Iterator
diff --git a/src/net/80211/net80211.c b/src/net/80211/net80211.c
index ffa5c911..d39958ba 100644
--- a/src/net/80211/net80211.c
+++ b/src/net/80211/net80211.c
@@ -668,11 +668,11 @@ struct io_buffer * net80211_mgmt_dequeue ( struct net80211_device *dev,
 			*signal = rxi->signal;
 		free ( rxi );
 
-		list_for_each_entry ( iobuf, &dev->mgmt_queue, list ) {
-			list_del ( &iobuf->list );
-			return iobuf;
-		}
-		assert ( 0 );
+		assert ( ! list_empty ( &dev->mgmt_queue ) );
+		iobuf = list_first_entry ( &dev->mgmt_queue, struct io_buffer,
+					   list );
+		list_del ( &iobuf->list );
+		return iobuf;
 	}
 
 	return NULL;
diff --git a/src/net/infiniband.c b/src/net/infiniband.c
index bdfc45d6..a6e4233a 100644
--- a/src/net/infiniband.c
+++ b/src/net/infiniband.c
@@ -982,12 +982,12 @@ struct ib_device * find_ibdev ( union ib_gid *gid ) {
 struct ib_device * last_opened_ibdev ( void ) {
 	struct ib_device *ibdev;
 
-	list_for_each_entry ( ibdev, &open_ib_devices, open_list ) {
-		assert ( ibdev->open_count != 0 );
-		return ibdev;
-	}
+	ibdev = list_first_entry ( &open_ib_devices, struct ib_device, list );
+	if ( ! ibdev )
+		return NULL;
 
-	return NULL;
+	assert ( ibdev->open_count != 0 );
+	return ibdev;
 }
 
 /* Drag in IPoIB */
diff --git a/src/net/netdevice.c b/src/net/netdevice.c
index 894b7e79..3a01a58d 100644
--- a/src/net/netdevice.c
+++ b/src/net/netdevice.c
@@ -328,11 +328,12 @@ void netdev_poll ( struct net_device *netdev ) {
 struct io_buffer * netdev_rx_dequeue ( struct net_device *netdev ) {
 	struct io_buffer *iobuf;
 
-	list_for_each_entry ( iobuf, &netdev->rx_queue, list ) {
-		list_del ( &iobuf->list );
-		return iobuf;
-	}
-	return NULL;
+	iobuf = list_first_entry ( &netdev->rx_queue, struct io_buffer, list );
+	if ( ! iobuf )
+		return NULL;
+
+	list_del ( &iobuf->list );
+	return iobuf;
 }
 
 /**
@@ -592,12 +593,13 @@ struct net_device * find_netdev_by_location ( unsigned int bus_type,
 struct net_device * last_opened_netdev ( void ) {
 	struct net_device *netdev;
 
-	list_for_each_entry ( netdev, &open_net_devices, open_list ) {
-		assert ( netdev_is_open ( netdev ) );
-		return netdev;
-	}
+	netdev = list_first_entry ( &open_net_devices, struct net_device,
+				    list );
+	if ( ! netdev )
+		return NULL;
 
-	return NULL;
+	assert ( netdev_is_open ( netdev ) );
+	return netdev;
 }
 
 /**
diff --git a/src/net/tcp.c b/src/net/tcp.c
index 1c824bdf..42064034 100644
--- a/src/net/tcp.c
+++ b/src/net/tcp.c
@@ -1014,9 +1014,8 @@ static void tcp_process_rx_queue ( struct tcp_connection *tcp ) {
 	 * queue, since tcp_discard() may remove packets from the RX
 	 * queue while we are processing.
 	 */
-	while ( ! list_empty ( &tcp->rx_queue ) ) {
-		list_for_each_entry ( iobuf, &tcp->rx_queue, list )
-			break;
+	while ( ( iobuf = list_first_entry ( &tcp->rx_queue, struct io_buffer,
+					     list ) ) ) {
 
 		/* Stop processing when we hit the first gap */
 		tcpqhdr = iobuf->data;