SYSUNINIT (9)

Leading comments

Copyright (c) 2003 Hiten M. Pandya
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or ot...

(The comments found at the beginning of the groff file "man9/SYSUNINIT.9freebsd".)

NAME

SYSINIT SYSUNINIT - a framework for dynamic kernel initialization

SYNOPSIS

In sys/param.h In sys/kernel.h Fn SYSINIT uniquifier enum sysinit_sub_id subsystem enum sysinit_elem_order order sysinit_cfunc_t func const void *ident Fn SYSUNINIT uniquifier enum sysinit_sub_id subsystem enum sysinit_elem_order order sysinit_cfunc_t func const void *ident

DESCRIPTION

ifconfig 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 Fn SYSINIT macro creates a Vt struct sysinit and stores it in a startup linker set. The Vt struct sysinit type as well as the subsystem identifier constants (SI_SUB_* ) and initialization ordering constants (SI_ORDER_* ) are defined in 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 Fn SYSINIT macro takes a Fa uniquifier argument to identify the particular function dispatch data, the Fa subsystem type of startup interface, the subsystem element Fa order of initialization within the subsystem, the Fa func function to call, and the data specified in Fa ident argument to pass the function.

The Fn SYSUNINIT macro behaves similarly to the Fn 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 Fa subsystem is used as the primary key and is sorted in ascending order. The Fa order is used as the secondary key and is sorted in ascending order. The relative order of two routines that have the same Fa subsystem and Fa 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 module 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 during 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_MODULE9, DEV_MODULE9, DRIVER_MODULE9, MTX_SYSINIT9, SYSCALL_MODULE9

HISTORY

The ifconfig framework first appeared in Fx 2.2 .

AUTHORS

An -nosplit The ifconfig framework was written by An Terrence Lambert Aq terry@FreeBSD.org .

This manual page was written by An Hiten Pandya Aq hmp@FreeBSD.org .