Separated out initialisation functions from startup/shutdown functions.

1 files changed, 101 insertions, 21 deletions

diff --git a/src/core/init.c b/src/core/init.c
index 61570fd1..ed91bf36 100644
--- a/src/core/init.c
+++ b/src/core/init.c
@@ -1,37 +1,117 @@
-/**************************************************************************
- * call_{init,reset,exit}_fns ()
- * 
- * Call the various initialisation and exit functions.  We use a
- * function table so that we don't end up dragging in an object just
- * because we call its initialisation function.
- **************************************************************************
+/*
+ * Copyright (C) 2007 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
+#include <gpxe/device.h>
 #include <gpxe/init.h>
 
+/** @file
+ *
+ * Initialisation, startup and shutdown routines
+ *
+ */
+
+/** Registered initialisation functions */
 static struct init_fn init_fns[0]
-	__table_start ( struct init_fn, init_fn );
+	__table_start ( struct init_fn, init_fns );
 static struct init_fn init_fns_end[0]
-	__table_end ( struct init_fn, init_fn );
+	__table_end ( struct init_fn, init_fns );
+
+/** Registered startup/shutdown functions */
+static struct startup_fn startup_fns[0]
+	__table_start ( struct startup_fn, startup_fns );
+static struct startup_fn startup_fns_end[0]
+	__table_end ( struct startup_fn, startup_fns );
 
-void call_init_fns ( void ) {
+/** "startup() has been called" flag */
+static int started = 0;
+
+/**
+ * Initialise gPXE
+ *
+ * This function performs the one-time-only and irreversible
+ * initialisation steps, such as initialising the heap.  It must be
+ * called before (almost) any other function.
+ *
+ * There is, by definition, no counterpart to this function on the
+ * shutdown path.
+ */
+void initialise ( void ) {
 	struct init_fn *init_fn;
 
-	for ( init_fn = init_fns; init_fn < init_fns_end ; init_fn++ ) {
-		if ( init_fn->init )
-			init_fn->init ();
+	/* Call registered initialisation functions */
+	for ( init_fn = init_fns ; init_fn < init_fns_end ; init_fn++ ) {
+		init_fn->initialise ();
 	}
 }
 
-void call_exit_fns ( void ) {
-	struct init_fn *init_fn;
+/**
+ * Start up gPXE
+ *
+ * This function performs the repeatable initialisation steps, such as
+ * probing devices.  You may call startup() and shutdown() multiple
+ * times (as is done via the PXE API when PXENV_START_UNDI is used).
+ */
+void startup ( void ) {
+	struct startup_fn *startup_fn;
+
+	if ( started )
+		return;
+
+	/* Call registered startup functions */
+	for ( startup_fn = startup_fns ; startup_fn < startup_fns_end ;
+	      startup_fn++ ) {
+		if ( startup_fn->startup )
+			startup_fn->startup();
+	}
 
-	/* 
-	 * Exit functions are called in reverse order to
-	 * initialisation functions.
+	/* Probe for all devices.  Treated separately because nothing
+	 * else will drag in device.o
 	 */
-	for ( init_fn = init_fns_end - 1; init_fn >= init_fns ; init_fn-- ) {
-		if ( init_fn->exit )
-			init_fn->exit ();
+	probe_devices();
+
+	started = 1;
+}
+
+/**
+ * Shut down gPXE
+ *
+ * This function reverses the actions of startup(), and leaves gPXE in
+ * a state ready to be removed from memory.  You may call startup()
+ * again after calling shutdown().
+
+ * Call this function only once, before either exiting main() or
+ * starting up a non-returnable image.
+ */
+void shutdown ( void ) {
+	struct startup_fn *startup_fn;
+
+	if ( ! started )
+		return;
+
+	/* Remove all devices */
+	remove_devices();
+
+	/* Call registered shutdown functions (in reverse order) */
+	for ( startup_fn = startup_fns_end - 1 ; startup_fn >= startup_fns ;
+	      startup_fn-- ) {
+		if ( startup_fn->shutdown )
+			startup_fn->shutdown();
 	}
+
+	started = 0;
 }