Merge tag 'trace-printf-v6.13' of git://git.kernel.org/pub/scm/linux/kernel/git/trace...
[drm/drm-misc.git] / Documentation / kbuild / kconfig-language.rst
blob2619fdf56e682ae15b3966ebad55bf27c736bc37
1 ================
2 Kconfig Language
3 ================
5 Introduction
6 ------------
8 The configuration database is a collection of configuration options
9 organized in a tree structure::
11         +- Code maturity level options
12         |  +- Prompt for development and/or incomplete code/drivers
13         +- General setup
14         |  +- Networking support
15         |  +- System V IPC
16         |  +- BSD Process Accounting
17         |  +- Sysctl support
18         +- Loadable module support
19         |  +- Enable loadable module support
20         |     +- Set version information on all module symbols
21         |     +- Kernel module loader
22         +- ...
24 Every entry has its own dependencies. These dependencies are used
25 to determine the visibility of an entry. Any child entry is only
26 visible if its parent entry is also visible.
28 Menu entries
29 ------------
31 Most entries define a config option; all other entries help to organize
32 them. A single configuration option is defined like this::
34   config MODVERSIONS
35         bool "Set version information on all module symbols"
36         depends on MODULES
37         help
38           Usually, modules have to be recompiled whenever you switch to a new
39           kernel.  ...
41 Every line starts with a key word and can be followed by multiple
42 arguments.  "config" starts a new config entry. The following lines
43 define attributes for this config option. Attributes can be the type of
44 the config option, input prompt, dependencies, help text and default
45 values. A config option can be defined multiple times with the same
46 name, but every definition can have only a single input prompt and the
47 type must not conflict.
49 Menu attributes
50 ---------------
52 A menu entry can have a number of attributes. Not all of them are
53 applicable everywhere (see syntax).
55 - type definition: "bool"/"tristate"/"string"/"hex"/"int"
57   Every config option must have a type. There are only two basic types:
58   tristate and string; the other types are based on these two. The type
59   definition optionally accepts an input prompt, so these two examples
60   are equivalent::
62         bool "Networking support"
64   and::
66         bool
67         prompt "Networking support"
69 - input prompt: "prompt" <prompt> ["if" <expr>]
71   Every menu entry can have at most one prompt, which is used to display
72   to the user. Optionally dependencies only for this prompt can be added
73   with "if". If a prompt is not present, the config option is a non-visible
74   symbol, meaning its value cannot be directly changed by the user (such as
75   altering the value in ``.config``) and the option will not appear in any
76   config menus. Its value can only be set via "default" and "select" (see
77   below).
79 - default value: "default" <expr> ["if" <expr>]
81   A config option can have any number of default values. If multiple
82   default values are visible, only the first defined one is active.
83   Default values are not limited to the menu entry where they are
84   defined. This means the default can be defined somewhere else or be
85   overridden by an earlier definition.
86   The default value is only assigned to the config symbol if no other
87   value was set by the user (via the input prompt above). If an input
88   prompt is visible the default value is presented to the user and can
89   be overridden by him.
90   Optionally, dependencies only for this default value can be added with
91   "if".
93  The default value deliberately defaults to 'n' in order to avoid bloating the
94  build. With few exceptions, new config options should not change this. The
95  intent is for "make oldconfig" to add as little as possible to the config from
96  release to release.
98  Note:
99         Things that merit "default y/m" include:
101         a) A new Kconfig option for something that used to always be built
102            should be "default y".
104         b) A new gatekeeping Kconfig option that hides/shows other Kconfig
105            options (but does not generate any code of its own), should be
106            "default y" so people will see those other options.
108         c) Sub-driver behavior or similar options for a driver that is
109            "default n". This allows you to provide sane defaults.
111         d) Hardware or infrastructure that everybody expects, such as CONFIG_NET
112            or CONFIG_BLOCK. These are rare exceptions.
114 - type definition + default value::
116         "def_bool"/"def_tristate" <expr> ["if" <expr>]
118   This is a shorthand notation for a type definition plus a value.
119   Optionally dependencies for this default value can be added with "if".
121 - dependencies: "depends on" <expr>
123   This defines a dependency for this menu entry. If multiple
124   dependencies are defined, they are connected with '&&'. Dependencies
125   are applied to all other options within this menu entry (which also
126   accept an "if" expression), so these two examples are equivalent::
128         bool "foo" if BAR
129         default y if BAR
131   and::
133         depends on BAR
134         bool "foo"
135         default y
137 - reverse dependencies: "select" <symbol> ["if" <expr>]
139   While normal dependencies reduce the upper limit of a symbol (see
140   below), reverse dependencies can be used to force a lower limit of
141   another symbol. The value of the current menu symbol is used as the
142   minimal value <symbol> can be set to. If <symbol> is selected multiple
143   times, the limit is set to the largest selection.
144   Reverse dependencies can only be used with boolean or tristate
145   symbols.
147   Note:
148         select should be used with care. select will force
149         a symbol to a value without visiting the dependencies.
150         By abusing select you are able to select a symbol FOO even
151         if FOO depends on BAR that is not set.
152         In general use select only for non-visible symbols
153         (no prompts anywhere) and for symbols with no dependencies.
154         That will limit the usefulness but on the other hand avoid
155         the illegal configurations all over.
157         If "select" <symbol> is followed by "if" <expr>, <symbol> will be
158         selected by the logical AND of the value of the current menu symbol
159         and <expr>. This means, the lower limit can be downgraded due to the
160         presence of "if" <expr>. This behavior may seem weird, but we rely on
161         it. (The future of this behavior is undecided.)
163 - weak reverse dependencies: "imply" <symbol> ["if" <expr>]
165   This is similar to "select" as it enforces a lower limit on another
166   symbol except that the "implied" symbol's value may still be set to n
167   from a direct dependency or with a visible prompt.
169   Given the following example::
171     config FOO
172         tristate "foo"
173         imply BAZ
175     config BAZ
176         tristate "baz"
177         depends on BAR
179   The following values are possible:
181         ===             ===             =============   ==============
182         FOO             BAR             BAZ's default   choice for BAZ
183         ===             ===             =============   ==============
184         n               y               n               N/m/y
185         m               y               m               M/y/n
186         y               y               y               Y/m/n
187         n               m               n               N/m
188         m               m               m               M/n
189         y               m               m               M/n
190         y               n               *               N
191         ===             ===             =============   ==============
193   This is useful e.g. with multiple drivers that want to indicate their
194   ability to hook into a secondary subsystem while allowing the user to
195   configure that subsystem out without also having to unset these drivers.
197   Note: If the combination of FOO=y and BAZ=m causes a link error,
198   you can guard the function call with IS_REACHABLE()::
200         foo_init()
201         {
202                 if (IS_REACHABLE(CONFIG_BAZ))
203                         baz_register(&foo);
204                 ...
205         }
207   Note: If the feature provided by BAZ is highly desirable for FOO,
208   FOO should imply not only BAZ, but also its dependency BAR::
210     config FOO
211         tristate "foo"
212         imply BAR
213         imply BAZ
215   Note: If "imply" <symbol> is followed by "if" <expr>, the default of <symbol>
216   will be the logical AND of the value of the current menu symbol and <expr>.
217   (The future of this behavior is undecided.)
219 - limiting menu display: "visible if" <expr>
221   This attribute is only applicable to menu blocks, if the condition is
222   false, the menu block is not displayed to the user (the symbols
223   contained there can still be selected by other symbols, though). It is
224   similar to a conditional "prompt" attribute for individual menu
225   entries. Default value of "visible" is true.
227 - numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
229   This allows to limit the range of possible input values for int
230   and hex symbols. The user can only input a value which is larger than
231   or equal to the first symbol and smaller than or equal to the second
232   symbol.
234 - help text: "help"
236   This defines a help text. The end of the help text is determined by
237   the indentation level, this means it ends at the first line which has
238   a smaller indentation than the first line of the help text.
240 - module attribute: "modules"
241   This declares the symbol to be used as the MODULES symbol, which
242   enables the third modular state for all config symbols.
243   At most one symbol may have the "modules" option set.
245 Menu dependencies
246 -----------------
248 Dependencies define the visibility of a menu entry and can also reduce
249 the input range of tristate symbols. The tristate logic used in the
250 expressions uses one more state than normal boolean logic to express the
251 module state. Dependency expressions have the following syntax::
253   <expr> ::= <symbol>                           (1)
254            <symbol> '=' <symbol>                (2)
255            <symbol> '!=' <symbol>               (3)
256            <symbol1> '<' <symbol2>              (4)
257            <symbol1> '>' <symbol2>              (4)
258            <symbol1> '<=' <symbol2>             (4)
259            <symbol1> '>=' <symbol2>             (4)
260            '(' <expr> ')'                       (5)
261            '!' <expr>                           (6)
262            <expr> '&&' <expr>                   (7)
263            <expr> '||' <expr>                   (8)
265 Expressions are listed in decreasing order of precedence.
267 (1) Convert the symbol into an expression. Boolean and tristate symbols
268     are simply converted into the respective expression values. All
269     other symbol types result in 'n'.
270 (2) If the values of both symbols are equal, it returns 'y',
271     otherwise 'n'.
272 (3) If the values of both symbols are equal, it returns 'n',
273     otherwise 'y'.
274 (4) If value of <symbol1> is respectively lower, greater, lower-or-equal,
275     or greater-or-equal than value of <symbol2>, it returns 'y',
276     otherwise 'n'.
277 (5) Returns the value of the expression. Used to override precedence.
278 (6) Returns the result of (2-/expr/).
279 (7) Returns the result of min(/expr/, /expr/).
280 (8) Returns the result of max(/expr/, /expr/).
282 An expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2
283 respectively for calculations). A menu entry becomes visible when its
284 expression evaluates to 'm' or 'y'.
286 There are two types of symbols: constant and non-constant symbols.
287 Non-constant symbols are the most common ones and are defined with the
288 'config' statement. Non-constant symbols consist entirely of alphanumeric
289 characters or underscores.
290 Constant symbols are only part of expressions. Constant symbols are
291 always surrounded by single or double quotes. Within the quote, any
292 other character is allowed and the quotes can be escaped using '\'.
294 Menu structure
295 --------------
297 The position of a menu entry in the tree is determined in two ways. First
298 it can be specified explicitly::
300   menu "Network device support"
301         depends on NET
303   config NETDEVICES
304         ...
306   endmenu
308 All entries within the "menu" ... "endmenu" block become a submenu of
309 "Network device support". All subentries inherit the dependencies from
310 the menu entry, e.g. this means the dependency "NET" is added to the
311 dependency list of the config option NETDEVICES.
313 The other way to generate the menu structure is done by analyzing the
314 dependencies. If a menu entry somehow depends on the previous entry, it
315 can be made a submenu of it. First, the previous (parent) symbol must
316 be part of the dependency list and then one of these two conditions
317 must be true:
319 - the child entry must become invisible, if the parent is set to 'n'
320 - the child entry must only be visible, if the parent is visible::
322     config MODULES
323         bool "Enable loadable module support"
325     config MODVERSIONS
326         bool "Set version information on all module symbols"
327         depends on MODULES
329     comment "module support disabled"
330         depends on !MODULES
332 MODVERSIONS directly depends on MODULES, this means it's only visible if
333 MODULES is different from 'n'. The comment on the other hand is only
334 visible when MODULES is set to 'n'.
337 Kconfig syntax
338 --------------
340 The configuration file describes a series of menu entries, where every
341 line starts with a keyword (except help texts). The following keywords
342 end a menu entry:
344 - config
345 - menuconfig
346 - choice/endchoice
347 - comment
348 - menu/endmenu
349 - if/endif
350 - source
352 The first five also start the definition of a menu entry.
354 config::
356         "config" <symbol>
357         <config options>
359 This defines a config symbol <symbol> and accepts any of above
360 attributes as options.
362 menuconfig::
364         "menuconfig" <symbol>
365         <config options>
367 This is similar to the simple config entry above, but it also gives a
368 hint to front ends, that all suboptions should be displayed as a
369 separate list of options. To make sure all the suboptions will really
370 show up under the menuconfig entry and not outside of it, every item
371 from the <config options> list must depend on the menuconfig symbol.
372 In practice, this is achieved by using one of the next two constructs::
374   (1):
375   menuconfig M
376   if M
377       config C1
378       config C2
379   endif
381   (2):
382   menuconfig M
383   config C1
384       depends on M
385   config C2
386       depends on M
388 In the following examples (3) and (4), C1 and C2 still have the M
389 dependency, but will not appear under menuconfig M anymore, because
390 of C0, which doesn't depend on M::
392   (3):
393   menuconfig M
394       config C0
395   if M
396       config C1
397       config C2
398   endif
400   (4):
401   menuconfig M
402   config C0
403   config C1
404       depends on M
405   config C2
406       depends on M
408 choices::
410         "choice"
411         <choice options>
412         <choice block>
413         "endchoice"
415 This defines a choice group and accepts "prompt", "default", "depends on", and
416 "help" attributes as options.
418 A choice only allows a single config entry to be selected.
420 comment::
422         "comment" <prompt>
423         <comment options>
425 This defines a comment which is displayed to the user during the
426 configuration process and is also echoed to the output files. The only
427 possible options are dependencies.
429 menu::
431         "menu" <prompt>
432         <menu options>
433         <menu block>
434         "endmenu"
436 This defines a menu block, see "Menu structure" above for more
437 information. The only possible options are dependencies and "visible"
438 attributes.
440 if::
442         "if" <expr>
443         <if block>
444         "endif"
446 This defines an if block. The dependency expression <expr> is appended
447 to all enclosed menu entries.
449 source::
451         "source" <prompt>
453 This reads the specified configuration file. This file is always parsed.
455 mainmenu::
457         "mainmenu" <prompt>
459 This sets the config program's title bar if the config program chooses
460 to use it. It should be placed at the top of the configuration, before any
461 other statement.
463 '#' Kconfig source file comment:
465 An unquoted '#' character anywhere in a source file line indicates
466 the beginning of a source file comment.  The remainder of that line
467 is a comment.
470 Kconfig hints
471 -------------
472 This is a collection of Kconfig tips, most of which aren't obvious at
473 first glance and most of which have become idioms in several Kconfig
474 files.
476 Adding common features and make the usage configurable
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478 It is a common idiom to implement a feature/functionality that are
479 relevant for some architectures but not all.
480 The recommended way to do so is to use a config variable named HAVE_*
481 that is defined in a common Kconfig file and selected by the relevant
482 architectures.
483 An example is the generic IOMAP functionality.
485 We would in lib/Kconfig see::
487   # Generic IOMAP is used to ...
488   config HAVE_GENERIC_IOMAP
490   config GENERIC_IOMAP
491         depends on HAVE_GENERIC_IOMAP && FOO
493 And in lib/Makefile we would see::
495         obj-$(CONFIG_GENERIC_IOMAP) += iomap.o
497 For each architecture using the generic IOMAP functionality we would see::
499   config X86
500         select ...
501         select HAVE_GENERIC_IOMAP
502         select ...
504 Note: we use the existing config option and avoid creating a new
505 config variable to select HAVE_GENERIC_IOMAP.
507 Note: the use of the internal config variable HAVE_GENERIC_IOMAP, it is
508 introduced to overcome the limitation of select which will force a
509 config option to 'y' no matter the dependencies.
510 The dependencies are moved to the symbol GENERIC_IOMAP and we avoid the
511 situation where select forces a symbol equals to 'y'.
513 Adding features that need compiler support
514 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
516 There are several features that need compiler support. The recommended way
517 to describe the dependency on the compiler feature is to use "depends on"
518 followed by a test macro::
520   config STACKPROTECTOR
521         bool "Stack Protector buffer overflow detection"
522         depends on $(cc-option,-fstack-protector)
523         ...
525 If you need to expose a compiler capability to makefiles and/or C source files,
526 `CC_HAS_` is the recommended prefix for the config option::
528   config CC_HAS_FOO
529         def_bool $(success,$(srctree)/scripts/cc-check-foo.sh $(CC))
531 Build as module only
532 ~~~~~~~~~~~~~~~~~~~~
533 To restrict a component build to module-only, qualify its config symbol
534 with "depends on m".  E.g.::
536   config FOO
537         depends on BAR && m
539 limits FOO to module (=m) or disabled (=n).
541 Compile-testing
542 ~~~~~~~~~~~~~~~
543 If a config symbol has a dependency, but the code controlled by the config
544 symbol can still be compiled if the dependency is not met, it is encouraged to
545 increase build coverage by adding an "|| COMPILE_TEST" clause to the
546 dependency. This is especially useful for drivers for more exotic hardware, as
547 it allows continuous-integration systems to compile-test the code on a more
548 common system, and detect bugs that way.
549 Note that compile-tested code should avoid crashing when run on a system where
550 the dependency is not met.
552 Architecture and platform dependencies
553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
554 Due to the presence of stubs, most drivers can now be compiled on most
555 architectures. However, this does not mean it makes sense to have all drivers
556 available everywhere, as the actual hardware may only exist on specific
557 architectures and platforms. This is especially true for on-SoC IP cores,
558 which may be limited to a specific vendor or SoC family.
560 To prevent asking the user about drivers that cannot be used on the system(s)
561 the user is compiling a kernel for, and if it makes sense, config symbols
562 controlling the compilation of a driver should contain proper dependencies,
563 limiting the visibility of the symbol to (a superset of) the platform(s) the
564 driver can be used on. The dependency can be an architecture (e.g. ARM) or
565 platform (e.g. ARCH_OMAP4) dependency. This makes life simpler not only for
566 distro config owners, but also for every single developer or user who
567 configures a kernel.
569 Such a dependency can be relaxed by combining it with the compile-testing rule
570 above, leading to:
572   config FOO
573         bool "Support for foo hardware"
574         depends on ARCH_FOO_VENDOR || COMPILE_TEST
576 Optional dependencies
577 ~~~~~~~~~~~~~~~~~~~~~
579 Some drivers are able to optionally use a feature from another module
580 or build cleanly with that module disabled, but cause a link failure
581 when trying to use that loadable module from a built-in driver.
583 The most common way to express this optional dependency in Kconfig logic
584 uses the slightly counterintuitive::
586   config FOO
587         tristate "Support for foo hardware"
588         depends on BAR || !BAR
590 This means that there is either a dependency on BAR that disallows
591 the combination of FOO=y with BAR=m, or BAR is completely disabled.
592 For a more formalized approach if there are multiple drivers that have
593 the same dependency, a helper symbol can be used, like::
595   config FOO
596         tristate "Support for foo hardware"
597         depends on BAR_OPTIONAL
599   config BAR_OPTIONAL
600         def_tristate BAR || !BAR
602 Kconfig recursive dependency limitations
603 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
605 If you've hit the Kconfig error: "recursive dependency detected" you've run
606 into a recursive dependency issue with Kconfig, a recursive dependency can be
607 summarized as a circular dependency. The kconfig tools need to ensure that
608 Kconfig files comply with specified configuration requirements. In order to do
609 that kconfig must determine the values that are possible for all Kconfig
610 symbols, this is currently not possible if there is a circular relation
611 between two or more Kconfig symbols. For more details refer to the "Simple
612 Kconfig recursive issue" subsection below. Kconfig does not do recursive
613 dependency resolution; this has a few implications for Kconfig file writers.
614 We'll first explain why this issues exists and then provide an example
615 technical limitation which this brings upon Kconfig developers. Eager
616 developers wishing to try to address this limitation should read the next
617 subsections.
619 Simple Kconfig recursive issue
620 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
622 Read: Documentation/kbuild/Kconfig.recursion-issue-01
624 Test with::
626   make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig
628 Cumulative Kconfig recursive issue
629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
631 Read: Documentation/kbuild/Kconfig.recursion-issue-02
633 Test with::
635   make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig
637 Practical solutions to kconfig recursive issue
638 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
640 Developers who run into the recursive Kconfig issue have two options
641 at their disposal. We document them below and also provide a list of
642 historical issues resolved through these different solutions.
644   a) Remove any superfluous "select FOO" or "depends on FOO"
645   b) Match dependency semantics:
647         b1) Swap all "select FOO" to "depends on FOO" or,
649         b2) Swap all "depends on FOO" to "select FOO"
651 The resolution to a) can be tested with the sample Kconfig file
652 Documentation/kbuild/Kconfig.recursion-issue-01 through the removal
653 of the "select CORE" from CORE_BELL_A_ADVANCED as that is implicit already
654 since CORE_BELL_A depends on CORE. At times it may not be possible to remove
655 some dependency criteria, for such cases you can work with solution b).
657 The two different resolutions for b) can be tested in the sample Kconfig file
658 Documentation/kbuild/Kconfig.recursion-issue-02.
660 Below is a list of examples of prior fixes for these types of recursive issues;
661 all errors appear to involve one or more "select" statements and one or more
662 "depends on".
664 ============    ===================================
665 commit          fix
666 ============    ===================================
667 06b718c01208    select A -> depends on A
668 c22eacfe82f9    depends on A -> depends on B
669 6a91e854442c    select A -> depends on A
670 118c565a8f2e    select A -> select B
671 f004e5594705    select A -> depends on A
672 c7861f37b4c6    depends on A -> (null)
673 80c69915e5fb    select A -> (null)              (1)
674 c2218e26c0d0    select A -> depends on A        (1)
675 d6ae99d04e1c    select A -> depends on A
676 95ca19cf8cbf    select A -> depends on A
677 8f057d7bca54    depends on A -> (null)
678 8f057d7bca54    depends on A -> select A
679 a0701f04846e    select A -> depends on A
680 0c8b92f7f259    depends on A -> (null)
681 e4e9e0540928    select A -> depends on A        (2)
682 7453ea886e87    depends on A > (null)           (1)
683 7b1fff7e4fdf    select A -> depends on A
684 86c747d2a4f0    select A -> depends on A
685 d9f9ab51e55e    select A -> depends on A
686 0c51a4d8abd6    depends on A -> select A        (3)
687 e98062ed6dc4    select A -> depends on A        (3)
688 91e5d284a7f1    select A -> (null)
689 ============    ===================================
691 (1) Partial (or no) quote of error.
692 (2) That seems to be the gist of that fix.
693 (3) Same error.
695 Future kconfig work
696 ~~~~~~~~~~~~~~~~~~~
698 Work on kconfig is welcomed on both areas of clarifying semantics and on
699 evaluating the use of a full SAT solver for it. A full SAT solver can be
700 desirable to enable more complex dependency mappings and / or queries,
701 for instance one possible use case for a SAT solver could be that of handling
702 the current known recursive dependency issues. It is not known if this would
703 address such issues but such evaluation is desirable. If support for a full SAT
704 solver proves too complex or that it cannot address recursive dependency issues
705 Kconfig should have at least clear and well defined semantics which also
706 addresses and documents limitations or requirements such as the ones dealing
707 with recursive dependencies.
709 Further work on both of these areas is welcomed on Kconfig. We elaborate
710 on both of these in the next two subsections.
712 Semantics of Kconfig
713 ~~~~~~~~~~~~~~~~~~~~
715 The use of Kconfig is broad, Linux is now only one of Kconfig's users:
716 one study has completed a broad analysis of Kconfig use in 12 projects [0]_.
717 Despite its widespread use, and although this document does a reasonable job
718 in documenting basic Kconfig syntax a more precise definition of Kconfig
719 semantics is welcomed. One project deduced Kconfig semantics through
720 the use of the xconfig configurator [1]_. Work should be done to confirm if
721 the deduced semantics matches our intended Kconfig design goals.
722 Another project formalized a denotational semantics of a core subset of
723 the Kconfig language [10]_.
725 Having well defined semantics can be useful for tools for practical
726 evaluation of dependencies, for instance one such case was work to
727 express in boolean abstraction of the inferred semantics of Kconfig to
728 translate Kconfig logic into boolean formulas and run a SAT solver on this to
729 find dead code / features (always inactive), 114 dead features were found in
730 Linux using this methodology [1]_ (Section 8: Threats to validity).
731 The kismet tool, based on the semantics in [10]_, finds abuses of reverse
732 dependencies and has led to dozens of committed fixes to Linux Kconfig files [11]_.
734 Confirming this could prove useful as Kconfig stands as one of the leading
735 industrial variability modeling languages [1]_ [2]_. Its study would help
736 evaluate practical uses of such languages, their use was only theoretical
737 and real world requirements were not well understood. As it stands though
738 only reverse engineering techniques have been used to deduce semantics from
739 variability modeling languages such as Kconfig [3]_.
741 .. [0] https://www.eng.uwaterloo.ca/~shshe/kconfig_semantics.pdf
742 .. [1] https://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
743 .. [2] https://gsd.uwaterloo.ca/sites/default/files/ase241-berger_0.pdf
744 .. [3] https://gsd.uwaterloo.ca/sites/default/files/icse2011.pdf
746 Full SAT solver for Kconfig
747 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
749 Although SAT solvers [4]_ haven't yet been used by Kconfig directly, as noted
750 in the previous subsection, work has been done however to express in boolean
751 abstraction the inferred semantics of Kconfig to translate Kconfig logic into
752 boolean formulas and run a SAT solver on it [5]_. Another known related project
753 is CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which
754 has been introduced first with [9]_.  The basic concept of undertaker is to
755 extract variability models from Kconfig and put them together with a
756 propositional formula extracted from CPP #ifdefs and build-rules into a SAT
757 solver in order to find dead code, dead files, and dead symbols. If using a SAT
758 solver is desirable on Kconfig one approach would be to evaluate repurposing
759 such efforts somehow on Kconfig. There is enough interest from mentors of
760 existing projects to not only help advise how to integrate this work upstream
761 but also help maintain it long term. Interested developers should visit:
763 https://kernelnewbies.org/KernelProjects/kconfig-sat
765 .. [4] https://www.cs.cornell.edu/~sabhar/chapters/SATSolvers-KR-Handbook.pdf
766 .. [5] https://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
767 .. [6] https://cados.cs.fau.de
768 .. [7] https://vamos.cs.fau.de
769 .. [8] https://undertaker.cs.fau.de
770 .. [9] https://www4.cs.fau.de/Publications/2011/tartler_11_eurosys.pdf
771 .. [10] https://paulgazzillo.com/papers/esecfse21.pdf
772 .. [11] https://github.com/paulgazz/kmax