Kconfig Language

Introduction

The configuration database is a collection of configuration options organized in a tree structure:

+- Code maturity level options
|  +- Prompt for development and/or incomplete code/drivers
+- General setup
|  +- Networking support
|  +- System V IPC
|  +- BSD Process Accounting
|  +- Sysctl support
+- Loadable module support
|  +- Enable loadable module support
|     +- Set version information on all module symbols
|     +- Kernel module loader
+- ...

Every entry has its own dependencies. These dependencies are used to determine the visibility of an entry. Any child entry is only visible if its parent entry is also visible.

Kconfig syntax

The configuration file describes a series of menu entries, where every line starts with a keyword (except help texts). The following keywords end a menu entry:

  • config

  • menuconfig

  • choice/endchoice

  • comment

  • menu/endmenu

  • if/endif

  • source

The first five also start the definition of a menu entry.

config:

"config" <symbol>
<config options>

This defines a config symbol <symbol> and accepts any of above attributes as options.

menuconfig:

"menuconfig" <symbol>
<config options>

This is similar to the simple config entry above, but it also gives a hint to front ends, that all suboptions should be displayed as a separate list of options. To make sure all the suboptions will really show up under the menuconfig entry and not outside of it, every item from the <config options> list must depend on the menuconfig symbol. In practice, this is achieved by using one of the next two constructs:

(1):
menuconfig M
if M
    config C1
    config C2
endif

(2):
menuconfig M
config C1
    depends on M
config C2
    depends on M

In the following examples (3) and (4), C1 and C2 still have the M dependency, but will not appear under menuconfig M anymore, because of C0, which doesn’t depend on M:

(3):
menuconfig M
    config C0
if M
    config C1
    config C2
endif

(4):
menuconfig M
config C0
config C1
    depends on M
config C2
    depends on M

choices:

"choice"
<choice options>
<choice block>
"endchoice"

This defines a choice group and accepts “prompt”, “default”, “depends on”, and “help” attributes as options.

A choice only allows a single config entry to be selected.

comment:

"comment" <prompt>
<comment options>

This defines a comment which is displayed to the user during the configuration process and is also echoed to the output files. The only possible options are dependencies.

menu:

"menu" <prompt>
<menu options>
<menu block>
"endmenu"

This defines a menu block, see “Menu structure” above for more information. The only possible options are dependencies and “visible” attributes.

if:

"if" <expr>
<if block>
"endif"

This defines an if block. The dependency expression <expr> is appended to all enclosed menu entries.

source:

"source" <prompt>

This reads the specified configuration file. This file is always parsed.

mainmenu:

"mainmenu" <prompt>

This sets the config program’s title bar if the config program chooses to use it. It should be placed at the top of the configuration, before any other statement.

‘#’ Kconfig source file comment:

An unquoted ‘#’ character anywhere in a source file line indicates the beginning of a source file comment. The remainder of that line is a comment.

Kconfig hints

This is a collection of Kconfig tips, most of which aren’t obvious at first glance and most of which have become idioms in several Kconfig files.

Adding common features and make the usage configurable

It is a common idiom to implement a feature/functionality that are relevant for some architectures but not all. The recommended way to do so is to use a config variable named HAVE_* that is defined in a common Kconfig file and selected by the relevant architectures. An example is the generic IOMAP functionality.

We would in lib/Kconfig see:

# Generic IOMAP is used to ...
config HAVE_GENERIC_IOMAP

config GENERIC_IOMAP
      depends on HAVE_GENERIC_IOMAP && FOO

And in lib/Makefile we would see:

obj-$(CONFIG_GENERIC_IOMAP) += iomap.o

For each architecture using the generic IOMAP functionality we would see:

config X86
      select ...
      select HAVE_GENERIC_IOMAP
      select ...

Note: we use the existing config option and avoid creating a new config variable to select HAVE_GENERIC_IOMAP.

Note: the use of the internal config variable HAVE_GENERIC_IOMAP, it is introduced to overcome the limitation of select which will force a config option to ‘y’ no matter the dependencies. The dependencies are moved to the symbol GENERIC_IOMAP and we avoid the situation where select forces a symbol equals to ‘y’.

Adding features that need compiler support

There are several features that need compiler support. The recommended way to describe the dependency on the compiler feature is to use “depends on” followed by a test macro:

config STACKPROTECTOR
      bool "Stack Protector buffer overflow detection"
      depends on $(cc-option,-fstack-protector)
      ...

If you need to expose a compiler capability to makefiles and/or C source files, CC_HAS_ is the recommended prefix for the config option:

config CC_HAS_FOO
      def_bool $(success,$(srctree)/scripts/cc-check-foo.sh $(CC))

Build as module only

To restrict a component build to module-only, qualify its config symbol with “depends on m”. E.g.:

config FOO
      depends on BAR && m

limits FOO to module (=m) or disabled (=n).

Compile-testing

If a config symbol has a dependency, but the code controlled by the config symbol can still be compiled if the dependency is not met, it is encouraged to increase build coverage by adding an “|| COMPILE_TEST” clause to the dependency. This is especially useful for drivers for more exotic hardware, as it allows continuous-integration systems to compile-test the code on a more common system, and detect bugs that way. Note that compile-tested code should avoid crashing when run on a system where the dependency is not met.

Architecture and platform dependencies

Due to the presence of stubs, most drivers can now be compiled on most architectures. However, this does not mean it makes sense to have all drivers available everywhere, as the actual hardware may only exist on specific architectures and platforms. This is especially true for on-SoC IP cores, which may be limited to a specific vendor or SoC family.

To prevent asking the user about drivers that cannot be used on the system(s) the user is compiling a kernel for, and if it makes sense, config symbols controlling the compilation of a driver should contain proper dependencies, limiting the visibility of the symbol to (a superset of) the platform(s) the driver can be used on. The dependency can be an architecture (e.g. ARM) or platform (e.g. ARCH_OMAP4) dependency. This makes life simpler not only for distro config owners, but also for every single developer or user who configures a kernel.

Such a dependency can be relaxed by combining it with the compile-testing rule above, leading to:

config FOO

bool “Support for foo hardware” depends on ARCH_FOO_VENDOR || COMPILE_TEST

Optional dependencies

Some drivers are able to optionally use a feature from another module or build cleanly with that module disabled, but cause a link failure when trying to use that loadable module from a built-in driver.

The most common way to express this optional dependency in Kconfig logic uses the slightly counterintuitive:

config FOO
      tristate "Support for foo hardware"
      depends on BAR || !BAR

This means that there is either a dependency on BAR that disallows the combination of FOO=y with BAR=m, or BAR is completely disabled. For a more formalized approach if there are multiple drivers that have the same dependency, a helper symbol can be used, like:

config FOO
      tristate "Support for foo hardware"
      depends on BAR_OPTIONAL

config BAR_OPTIONAL
      def_tristate BAR || !BAR

Kconfig recursive dependency limitations

If you’ve hit the Kconfig error: “recursive dependency detected” you’ve run into a recursive dependency issue with Kconfig, a recursive dependency can be summarized as a circular dependency. The kconfig tools need to ensure that Kconfig files comply with specified configuration requirements. In order to do that kconfig must determine the values that are possible for all Kconfig symbols, this is currently not possible if there is a circular relation between two or more Kconfig symbols. For more details refer to the “Simple Kconfig recursive issue” subsection below. Kconfig does not do recursive dependency resolution; this has a few implications for Kconfig file writers. We’ll first explain why this issues exists and then provide an example technical limitation which this brings upon Kconfig developers. Eager developers wishing to try to address this limitation should read the next subsections.

Simple Kconfig recursive issue

Read: Documentation/kbuild/Kconfig.recursion-issue-01

Test with:

make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig

Cumulative Kconfig recursive issue

Read: Documentation/kbuild/Kconfig.recursion-issue-02

Test with:

make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig

Practical solutions to kconfig recursive issue

Developers who run into the recursive Kconfig issue have two options at their disposal. We document them below and also provide a list of historical issues resolved through these different solutions.

  1. Remove any superfluous “select FOO” or “depends on FOO”

  2. Match dependency semantics:

    b1) Swap all “select FOO” to “depends on FOO” or,

    b2) Swap all “depends on FOO” to “select FOO”

The resolution to a) can be tested with the sample Kconfig file Documentation/kbuild/Kconfig.recursion-issue-01 through the removal of the “select CORE” from CORE_BELL_A_ADVANCED as that is implicit already since CORE_BELL_A depends on CORE. At times it may not be possible to remove some dependency criteria, for such cases you can work with solution b).

The two different resolutions for b) can be tested in the sample Kconfig file Documentation/kbuild/Kconfig.recursion-issue-02.

Below is a list of examples of prior fixes for these types of recursive issues; all errors appear to involve one or more “select” statements and one or more “depends on”.

commit

fix

06b718c01208

select A -> depends on A

c22eacfe82f9

depends on A -> depends on B

6a91e854442c

select A -> depends on A

118c565a8f2e

select A -> select B

f004e5594705

select A -> depends on A

c7861f37b4c6

depends on A -> (null)

80c69915e5fb

select A -> (null) (1)

c2218e26c0d0

select A -> depends on A (1)

d6ae99d04e1c

select A -> depends on A

95ca19cf8cbf

select A -> depends on A

8f057d7bca54

depends on A -> (null)

8f057d7bca54

depends on A -> select A

a0701f04846e

select A -> depends on A

0c8b92f7f259

depends on A -> (null)

e4e9e0540928

select A -> depends on A (2)

7453ea886e87

depends on A > (null) (1)

7b1fff7e4fdf

select A -> depends on A

86c747d2a4f0

select A -> depends on A

d9f9ab51e55e

select A -> depends on A

0c51a4d8abd6

depends on A -> select A (3)

e98062ed6dc4

select A -> depends on A (3)

91e5d284a7f1

select A -> (null)

  1. Partial (or no) quote of error.

  2. That seems to be the gist of that fix.

  3. Same error.

Future kconfig work

Work on kconfig is welcomed on both areas of clarifying semantics and on evaluating the use of a full SAT solver for it. A full SAT solver can be desirable to enable more complex dependency mappings and / or queries, for instance one possible use case for a SAT solver could be that of handling the current known recursive dependency issues. It is not known if this would address such issues but such evaluation is desirable. If support for a full SAT solver proves too complex or that it cannot address recursive dependency issues Kconfig should have at least clear and well defined semantics which also addresses and documents limitations or requirements such as the ones dealing with recursive dependencies.

Further work on both of these areas is welcomed on Kconfig. We elaborate on both of these in the next two subsections.

Semantics of Kconfig

The use of Kconfig is broad, Linux is now only one of Kconfig’s users: one study has completed a broad analysis of Kconfig use in 12 projects [0]. Despite its widespread use, and although this document does a reasonable job in documenting basic Kconfig syntax a more precise definition of Kconfig semantics is welcomed. One project deduced Kconfig semantics through the use of the xconfig configurator [1]. Work should be done to confirm if the deduced semantics matches our intended Kconfig design goals. Another project formalized a denotational semantics of a core subset of the Kconfig language [10].

Having well defined semantics can be useful for tools for practical evaluation of dependencies, for instance one such case was work to express in boolean abstraction of the inferred semantics of Kconfig to translate Kconfig logic into boolean formulas and run a SAT solver on this to find dead code / features (always inactive), 114 dead features were found in Linux using this methodology [1] (Section 8: Threats to validity). The kismet tool, based on the semantics in [10], finds abuses of reverse dependencies and has led to dozens of committed fixes to Linux Kconfig files [11].

Confirming this could prove useful as Kconfig stands as one of the leading industrial variability modeling languages [1] [2]. Its study would help evaluate practical uses of such languages, their use was only theoretical and real world requirements were not well understood. As it stands though only reverse engineering techniques have been used to deduce semantics from variability modeling languages such as Kconfig [3].

Full SAT solver for Kconfig

Although SAT solvers [4] haven’t yet been used by Kconfig directly, as noted in the previous subsection, work has been done however to express in boolean abstraction the inferred semantics of Kconfig to translate Kconfig logic into boolean formulas and run a SAT solver on it [5]. Another known related project is CADOS [6] (former VAMOS [7]) and the tools, mainly undertaker [8], which has been introduced first with [9]. The basic concept of undertaker is to extract variability models from Kconfig and put them together with a propositional formula extracted from CPP #ifdefs and build-rules into a SAT solver in order to find dead code, dead files, and dead symbols. If using a SAT solver is desirable on Kconfig one approach would be to evaluate repurposing such efforts somehow on Kconfig. There is enough interest from mentors of existing projects to not only help advise how to integrate this work upstream but also help maintain it long term. Interested developers should visit:

https://kernelnewbies.org/KernelProjects/kconfig-sat