[src/trunk]: src/share/man/man9 Add documentation for the various module syst...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/2b9f24d65e1a
branches:  trunk
changeset: 757049:2b9f24d65e1a
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Wed Aug 11 18:20:09 2010 +0000

description:
Add documentation for the various module system initialization routines.

diffstat:

 share/man/man9/Makefile |   6 +++++-
 share/man/man9/module.9 |  47 +++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 50 insertions(+), 3 deletions(-)

diffs (100 lines):

diff -r ca831e704626 -r 2b9f24d65e1a share/man/man9/Makefile
--- a/share/man/man9/Makefile   Wed Aug 11 18:15:52 2010 +0000
+++ b/share/man/man9/Makefile   Wed Aug 11 18:20:09 2010 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.339 2010/08/07 22:21:30 pgoyette Exp $
+#       $NetBSD: Makefile,v 1.340 2010/08/11 18:20:09 pgoyette Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -435,11 +435,15 @@
        microuptime.9 nanouptime.9 \
        microuptime.9 getnanouptime.9
 MLINKS+=module.9 module_autoload.9 \
+       module.9 module_builtin_require_force.9 \
        module.9 module_find_section.9 \
        module.9 module_hold.9 \
+       module.9 module_init.9 \
        module.9 module_init_class.9 \
        module.9 module_load.9 \
+       module.9 module_load_vfs_init.9 \
        module.9 module_rele.9 \
+       module.9 module_start_unload_thread.9 \
        module.9 module_unload.9
 MLINKS+=mstohz.9 hztoms.9
 MLINKS+=mutex.9 mutex_init.9 mutex.9 mutex_destroy.9 mutex.9 mutex_enter.9 \
diff -r ca831e704626 -r 2b9f24d65e1a share/man/man9/module.9
--- a/share/man/man9/module.9   Wed Aug 11 18:15:52 2010 +0000
+++ b/share/man/man9/module.9   Wed Aug 11 18:20:09 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: module.9,v 1.10 2010/08/08 15:23:28 wiz Exp $
+.\"    $NetBSD: module.9,v 1.11 2010/08/11 18:20:09 pgoyette Exp $
 .\"
 .\" Copyright (c) 2010 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd August 8, 2010
+.Dd August 11, 2010
 .Dt MODULE 9
 .Os
 .Sh NAME
@@ -58,6 +58,14 @@
 .Fn module_rele "const char *"
 .Ft int
 .Fn module_find_section "const char *" "void **" "size_t *"
+.Ft void
+.Fn module_init "void"
+.Ft void
+.Fn module_start_unload_thread "void"
+.Ft void
+.Fn module_builtin_require_force "void"
+.Ft void
+.Fn module_load_vfs_init "void"
 .Sh DESCRIPTION
 Modules are sections of code that can be independently linked and selectively
 loaded into or unloaded from a running kernel.
@@ -311,6 +319,41 @@
 embedded filesystem image.
 This routine can only examine the linker data for the module that is
 currently being initialized;  it cannot examine data for any other module.
+.It Fn module_init "void"
+Initialize the module subsystem.
+Creates and initializes various data structures, locates all built-in
+modules, and establishes the sub-system's
+.Xr sysctl 8
+tree.
+.Fn module_init
+is called early in system initialization to facilitate use of security model
+modules.
+.It Fn module_start_unload_thread "void"
+Create the thread that attempts to automatically unload modules that were
+loaded via the
+.Fn module_autoload
+routine.
+.Fn module_start_unload_thread
+is called once the scheduler and timer functions are initialized.
+.Fn 
+.It Fn module_builtin_require_force "void"
+Mark as "disabled" any built-in modules that have not been successfully
+initialize.
+Modules marked "disabled" can only be loaded if the
+.Dv MODCTL_LOAD_FORCE
+is specified.
+.Fn module_builtin_require_force
+is called near the end of system initialization, after the
+.Xr init 8
+process is created.
+.It Fn module_load_vfs_init
+The module subsystem is initialized early, long before any file-systems
+are available.
+After the root file-system is mounted,
+.Fn module_load_vfs_init
+is used to enable loading modules from the file-system.
+Until this routine is called, modules can only be loaded if they were
+built-in to the kernel image or provided by the boot loader.
 .El
 .Sh LOCK PROTOCOL
 The