declare_module(9) [debian man page]

DECLARE_MODULE(9)					   BSD Kernel Developer's Manual					 DECLARE_MODULE(9)

NAME

     DECLARE_MODULE -- kernel module declaration macro

SYNOPSIS

     #include <sys/param.h>
     #include <sys/kernel.h>
     #include <sys/module.h>

     DECLARE_MODULE(name, moduledata_t data, sub, order);

DESCRIPTION

     The DECLARE_MODULE() macro declares a generic kernel module.  It is used to register the module with the system, using the SYSINIT() macro.
     DECLARE_MODULE() is usually used within other macros, such as DRIVER_MODULE(9), DEV_MODULE(9) and SYSCALL_MODULE(9).  Of course, it can also
     be called directly, for example in order to implement dynamic sysctls.

     The arguments it expects are:

     name    The module name, which will be used in the SYSINIT() call to identify the module.

     data    A moduledata_t structure, which contains two main items, the official name of the module name, which will be used in the module_t
	     structure and a pointer to the event handler function of type modeventhand_t.

     sub     An argument directed to the SYSINIT() macro.  Valid values for this are contained in the sysinit_sub_id enumeration (see
	     <sys/kernel.h>) and specify the type of system startup interfaces.  The DRIVER_MODULE(9) macro uses a value of SI_SUB_DRIVERS here
	     for example, since these modules contain a driver for a device.  For kernel modules that are loaded at runtime, a value of
	     SI_SUB_EXEC is common.

     order   An argument for SYSINIT().  It represents the KLDs order of initialization within the subsystem.  Valid values are defined in the
	     sysinit_elem_order enumeration (<sys/kernel.h>).

SEE ALSO

     DEV_MODULE(9), DRIVER_MODULE(9), module(9), SYSCALL_MODULE(9)

     /usr/include/sys/kernel.h, /usr/share/examples/kld

AUTHORS

     This manual page was written by Alexander Langer <alex@FreeBSD.org>, inspired by the KLD Facility Programming Tutorial by Andrew Reiter
     <arr@watson.org>.

BSD
								  January 6, 2005							       BSD

SYSINIT(9)						   BSD Kernel Developer's Manual						SYSINIT(9)

NAME

     SYSINIT, SYSUNINIT -- a framework for dynamic kernel initialization

SYNOPSIS

     #include <sys/param.h>
     #include <sys/kernel.h>

     SYSINIT(uniquifier, enum sysinit_sub_id subsystem, enum sysinit_elem_order order, sysinit_cfunc_t func, const void *ident);

     SYSUNINIT(uniquifier, enum sysinit_sub_id subsystem, enum sysinit_elem_order order, sysinit_cfunc_t func, const void *ident);

DESCRIPTION

     SYSINIT is a mechanism for scheduling the execution of initialization and teardown routines.  This is similar to init and fini routines with
     the addition of explicit ordering metadata.  It allows runtime ordering of subsystem initialization in the kernel as well as kernel modules
     (KLDs).

     The SYSINIT() macro creates a struct sysinit and stores it in a startup linker set.  The struct sysinit type as well as the subsystem identi-
     fier constants (SI_SUB_*) and initialization ordering constants (SI_ORDER_*) are defined in <sys/kernel.h>:

     struct sysinit {
	     enum sysinit_sub_id subsystem;  /* subsystem identifier*/
	     enum sysinit_elem_order order;  /* init order within subsystem*/
	     sysinit_cfunc_t func;	     /* function	     */
	     const void      *udata;	     /* multiplexer/argument */
     };

     The SYSINIT() macro takes a uniquifier argument to identify the particular function dispatch data, the subsystem type of startup interface,
     the subsystem element order of initialization within the subsystem, the func function to call, and the data specified in ident argument to
     pass the function.

     The SYSUNINIT() macro behaves similarly to the SYSINIT() macro except that it adds the data to a shutdown linker set.

     The startup linker set for the kernel is scanned during boot to build a sorted list of initialization routines.  The initialization routines
     are then executed in the sorted order.  The subsystem is used as the primary key and is sorted in ascending order.  The order is used as the
     secondary key and is sorted in ascending order.  The relative order of two routines that have the same subsystem and order is undefined.

     The startup linker sets for modules that are loaded together with the kernel by the boot loader are scanned during the SI_SUB_KLD subsystem
     initialization.  These modules' initialization routines are sorted and merged into the kernel's list of startup routines and are executed
     during boot along with the kernel's initialization routines.  Note that this has the effect that any initialization routines in a kernel mod-
     ule that are scheduled earlier than SI_SUB_KLD are not executed until after SI_SUB_KLD during boot.

     The startup linker set for a kernel module loaded at runtime via kldload(2) is scanned, sorted, and executed when the module is loaded.

     The shutdown linker set for a kernel module is scanned, sorted, and executed when a kernel module is unloaded.  The teardown routines are
     sorted in the reverse order of the initialization routines.  The teardown routines of the kernel and any loaded modules are not executed dur-
     ing shutdown.

EXAMPLES

     This example shows the SYSINIT which displays the copyright notice during boot:

	   static void
	   print_caddr_t(void *data)
	   {
		   printf("%s", (char *)data);
	   }
	   SYSINIT(announce, SI_SUB_COPYRIGHT, SI_ORDER_FIRST, print_caddr_t,
	       copyright);

SEE ALSO

     kld(4), DECLARE_MODULE(9), DEV_MODULE(9), DRIVER_MODULE(9), MTX_SYSINIT(9), SYSCALL_MODULE(9)

HISTORY

     The SYSINIT framework first appeared in FreeBSD 2.2.

AUTHORS

     The SYSINIT framework was written by Terrence Lambert <terry@FreeBSD.org>.

     This manual page was written by Hiten Pandya <hmp@FreeBSD.org>.

BSD
								 December 1, 2010							       BSD