Adding New Kernel Configuration OptionsContributed by &a.joerg;You should be familiar with the section about kernel configuration
before reading here.What's a Kernel Option, Anyway?The use of kernel options is basically described in the kernel configuration
section. There's also an explanation of “historic” and
“new-style” options. The ultimate goal is to eventually turn all
the supported options in the kernel into new-style ones, so for
people who correctly did a make depend
in their kernel compile directory after running
config8, the build process will automatically
pick up modified options, and only recompile those files where it is
necessary. Wiping out the old compile directory on each run of
config8 as it is still done now can then be
eliminated again.Basically, a kernel option is nothing else than the definition
of a C preprocessor macro for the kernel compilation process. To
make the build truly optional, the corresponding part of the kernel
source (or kernel .h file) must be written with
the option concept in mind, i.e. the default must have been made
overridable by the config option. This is usually done with
something like:
#ifndef THIS_OPTION
#define THIS_OPTION (some_default_value)
#endif /* THIS_OPTION */This way, an administrator mentioning another value for the
option in his config file will take the default out of effect, and
replace it with his new value. Clearly, the new value will be
substituted into the source code during the preprocessor run, so it
must be a valid C expression in whatever context the default value
would have been used.It is also possible to create value-less options that simply
enable or disable a particular piece of code by embracing it
in
#ifdef THAT_OPTION
[your code here]
#endifSimply mentioning THAT_OPTION in the config
file (with or without any value) will then turn on the corresponding
piece of code.People familiar with the C language will immediately recognize
that everything could be counted as a “config option” where there
is at least a single #ifdef
referencing it... However, it's unlikely that many people would
put
options notyet,notdefin their config file, and then wonder why the kernel compilation
falls over. :-)Clearly, using arbitrary names for the options makes it very
hard to track their usage throughout the kernel source tree. That
is the rationale behind the new-style option
scheme, where each option goes into a separate
.h file in the kernel compile directory, which
is by convention named
opt_foo.h. This way,
the usual Makefile dependencies could be applied, and make can determine what needs to be recompiled
once an option has been changed.The old-style option mechanism still has one advantage for local
options or maybe experimental options that have a short anticipated
lifetime: since it is easy to add a new #ifdef to the kernel source, this has already
made it a kernel config option. In this case, the administrator
using such an option is responsible himself for knowing about its
implications (and maybe manually forcing the recompilation of parts
of his kernel). Once the transition of all supported options has
been done, config8 will warn whenever an
unsupported option appears in the config file, but it will
nevertheless include it into the kernel Makefile.Now What Do I Have to Do for it?First, edit sys/conf/options (or
sys/i386/conf/options.<arch>, e. g. sys/i386/conf/options.i386), and select an opt_foo.h file where your new option would best go into.If there is already something that comes close to the purpose of
the new option, pick this. For example, options modifying the
overall behaviour of the SCSI subsystem can go into
opt_scsi.h. By default, simply mentioning an
option in the appropriate option file, say FOO,
implies its value will go into the corresponding file
opt_foo.h. This can be overridden on the
right-hand side of a rule by specifying another filename.If there is no
opt_foo.h already
available for the intended new option, invent a new name. Make it
meaningful, and comment the new section in the
options[.<arch>] file. config8 will automagically pick up the change, and create that file next time it is run. Most options should go in a header file by themselves..Packing too many options into a single
opt_foo.h will cause
too many kernel files to be rebuilt when one of the options has been
changed in the config file.Finally, find out which kernel files depend on the new option.
Unless you have just invented your option, and it does not exist
anywhere yet,
&prompt.user; find /usr/src/sys -name type f | xargs fgrep NEW_OPTION
is your friend in finding them. Go and edit all those files,
and add
#include "opt_foo.h"on top, before all the #include <xxx.h> stuff. This sequence
is most important as the options could override defaults from the
regular include files, if the defaults are of the form
#ifndef NEW_OPTION
#define NEW_OPTION (something)
#endif
in the regular header.Adding an option that overrides something in a system header
file (i.e., a file sitting in
/usr/include/sys/) is almost always a mistake.
opt_foo.h cannot be
included into those files since it would break the headers more
seriously, but if it is not included, then places that include it
may get an inconsistent value for the option. Yes, there are
precedents for this right now, but that does not make them more
correct.