Date: Thu, 5 Sep 2019 17:59:00 +0000 (UTC) From: Benedict Reuschling <bcr@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r53372 - head/en_US.ISO8859-1/books/arch-handbook/sysinit Message-ID: <201909051759.x85Hx0XR037052@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: bcr Date: Thu Sep 5 17:58:59 2019 New Revision: 53372 URL: https://svnweb.freebsd.org/changeset/doc/53372 Log: Fix errors reported by textproc/igor: - wrap long line - use two spaces at sentence start - use tabs instead of spaces - space after content - straggling <tag> Event: vBSDcon FreeBSD Hackathon Modified: head/en_US.ISO8859-1/books/arch-handbook/sysinit/chapter.xml Modified: head/en_US.ISO8859-1/books/arch-handbook/sysinit/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/arch-handbook/sysinit/chapter.xml Thu Sep 5 17:28:51 2019 (r53371) +++ head/en_US.ISO8859-1/books/arch-handbook/sysinit/chapter.xml Thu Sep 5 17:58:59 2019 (r53372) @@ -4,26 +4,38 @@ $FreeBSD$ --> -<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sysinit"> +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" + xml:id="sysinit"> <title>The SYSINIT Framework</title> - <indexterm><primary>SYSINIT</primary></indexterm> - <indexterm><primary>dynamic initialization</primary></indexterm> - <indexterm><primary>kernel initialization</primary> - <secondary>dynamic</secondary></indexterm> - <indexterm><primary>kernel modules</primary></indexterm> - <indexterm><primary>kernel linker</primary></indexterm> + <indexterm> + <primary>SYSINIT</primary> + </indexterm> + <indexterm> + <primary>dynamic initialization</primary> + </indexterm> + <indexterm> + <primary>kernel initialization</primary> + <secondary>dynamic</secondary> + </indexterm> + <indexterm> + <primary>kernel modules</primary> + </indexterm> + <indexterm> + <primary>kernel linker</primary> + </indexterm> <para>SYSINIT is the framework for a generic call sort and dispatch - mechanism. FreeBSD currently uses it for the dynamic - initialization of the kernel. SYSINIT allows FreeBSD's kernel + mechanism. FreeBSD currently uses it for the dynamic + initialization of the kernel. SYSINIT allows FreeBSD's kernel subsystems to be reordered, and added, removed, and replaced at kernel link time when the kernel or one of its modules is loaded without having to edit a statically ordered initialization routing - and recompile the kernel. This system also allows kernel modules, + and recompile the kernel. This system also allows kernel modules, currently called <firstterm>KLD's</firstterm>, to be separately compiled, linked, and initialized at boot time and loaded even - later while the system is already running. This is accomplished + later while the system is already running. This is accomplished using the <quote>kernel linker</quote> and <quote>linker sets</quote>.</para> @@ -32,13 +44,13 @@ <variablelist> <varlistentry> - <term>Linker Set</term> - <listitem> - <para>A linker technique in which the linker gathers - statically declared data throughout a program's source files - into a single contiguously addressable unit of - data.</para> - </listitem> + <term>Linker Set</term> + <listitem> + <para>A linker technique in which the linker gathers + statically declared data throughout a program's source + files into a single contiguously addressable unit of + data.</para> + </listitem> </varlistentry> </variablelist> </sect1> @@ -51,24 +63,25 @@ <para>SYSINIT relies on the ability of the linker to take static data declared at multiple locations throughout a program's source and group it together as a single contiguous chunk of - data. This linker technique is called a <quote>linker - set</quote>. SYSINIT uses two linker sets to maintain two data + data. This linker technique is called a <quote>linker + set</quote>. SYSINIT uses two linker sets to maintain two data sets containing each consumer's call order, function, and a pointer to the data to pass to that function.</para> <para>SYSINIT uses two priorities when ordering the functions for execution. The first priority is a subsystem ID giving an - overall order for SYSINIT's dispatch of functions. Current predeclared - ID's are in <filename><sys/kernel.h></filename> in the enum - list <literal>sysinit_sub_id</literal>. The second priority used - is an element order within the subsystem. Current predeclared - subsystem element orders are in + overall order for SYSINIT's dispatch of functions. Current + predeclared ID's are in + <filename><sys/kernel.h></filename> in the enum + list <literal>sysinit_sub_id</literal>. The second priority + used is an element order within the subsystem. Current + predeclared subsystem element orders are in <filename><sys/kernel.h></filename> in the enum list <literal>sysinit_elem_order</literal>.</para> - <indexterm><primary>pseudo-devices</primary></indexterm> + <indexterm><primary>pseudo-devices</primary></indexterm> - <para>There are currently two uses for SYSINIT. Function dispatch + <para>There are currently two uses for SYSINIT. Function dispatch at system startup and kernel module loads, and function dispatch at system shutdown and kernel module unload. Kernel subsystems often use system startup SYSINIT's to initialize data @@ -77,11 +90,11 @@ Device drivers should avoid using <literal>SYSINIT()</literal> directly. Instead drivers for real devices that are part of a bus structure should use <literal>DRIVER_MODULE()</literal> to - provide a function that detects the device and, if it is present, - initializes the device. It will do a few things specific to - devices and then call <literal>SYSINIT()</literal> itself. - For pseudo-devices, which are not part of a bus structure, - use <literal>DEV_MODULE()</literal>.</para> + provide a function that detects the device and, if it is + present, initializes the device. It will do a few things + specific to devices and then call <literal>SYSINIT()</literal> + itself. For pseudo-devices, which are not part of a bus + structure, use <literal>DEV_MODULE()</literal>.</para> </sect1> @@ -92,15 +105,15 @@ <title>Interface</title> <sect3> - <title>Headers</title> + <title>Headers</title> - <programlisting><sys/kernel.h></programlisting> + <programlisting><sys/kernel.h></programlisting> </sect3> <sect3> - <title>Macros</title> + <title>Macros</title> - <programlisting>SYSINIT(uniquifier, subsystem, order, func, ident) + <programlisting>SYSINIT(uniquifier, subsystem, order, func, ident) SYSUNINIT(uniquifier, subsystem, order, func, ident)</programlisting> </sect3> </sect2> @@ -109,14 +122,13 @@ SYSUNINIT(uniquifier, subsystem, order, func, ident)</ <title>Startup</title> <para>The <literal>SYSINIT()</literal> macro creates the - necessary SYSINIT data in SYSINIT's startup data set for - SYSINIT to sort and dispatch a function at system startup and - module load. <literal>SYSINIT()</literal> takes a uniquifier - that SYSINIT uses to identify the particular function dispatch - data, the subsystem order, the subsystem element order, the - function to call, and the data to pass the function. All - functions must take a constant pointer argument. - </para> + necessary SYSINIT data in SYSINIT's startup data set for + SYSINIT to sort and dispatch a function at system startup and + module load. <literal>SYSINIT()</literal> takes a uniquifier + that SYSINIT uses to identify the particular function dispatch + data, the subsystem order, the subsystem element order, the + function to call, and the data to pass the function. All + functions must take a constant pointer argument.</para> <example> <title>Example of a <literal>SYSINIT()</literal></title> @@ -138,9 +150,7 @@ void foo_arg(void *vdata) struct foo *foo = (struct foo *)vdata; foo_data(foo); } -SYSINIT(bar, SI_SUB_FOO, SI_ORDER_FOO, foo_arg, &foo_voodoo); - </programlisting> - </example> +SYSINIT(bar, SI_SUB_FOO, SI_ORDER_FOO, foo_arg, &foo_voodoo);</programlisting></example> <para>Note that <literal>SI_SUB_FOO</literal> and <literal>SI_ORDER_FOO</literal> need to be in the @@ -153,7 +163,8 @@ SYSINIT(bar, SI_SUB_FOO, SI_ORDER_FOO, foo_arg, &f handle tuning kernel parameters.</para> <example> - <title>Example of Adjusting <literal>SYSINIT()</literal> Order</title> + <title>Example of Adjusting <literal>SYSINIT()</literal> + Order</title> <programlisting>static void mptable_register(void *dummy __unused) @@ -171,8 +182,8 @@ SYSINIT(mptable_register, SI_SUB_TUNABLES - 1, SI_ORDE <title>Shutdown</title> <para>The <literal>SYSUNINIT()</literal> macro behaves similarly - to the <literal>SYSINIT()</literal> macro except that it adds - the SYSINIT data to SYSINIT's shutdown data set.</para> + to the <literal>SYSINIT()</literal> macro except that it adds + the SYSINIT data to SYSINIT's shutdown data set.</para> <example> <title>Example of a <literal>SYSUNINIT()</literal></title> @@ -192,8 +203,7 @@ struct foo_stack foo_stack = { void foo_flush(void *vdata) { } -SYSUNINIT(barfoo, SI_SUB_FOO, SI_ORDER_FOO, foo_flush, &foo_stack); - </programlisting> +SYSUNINIT(barfoo, SI_SUB_FOO, SI_ORDER_FOO, foo_flush, &foo_stack);</programlisting> </example> </sect2> </sect1>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201909051759.x85Hx0XR037052>