Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oddlama/autokernel
A tool for managing your kernel configuration that guarantees semantic correctness
https://github.com/oddlama/autokernel
configuration kconfig kernel rust
Last synced: 4 days ago
JSON representation
A tool for managing your kernel configuration that guarantees semantic correctness
- Host: GitHub
- URL: https://github.com/oddlama/autokernel
- Owner: oddlama
- License: mit
- Created: 2020-02-09T17:00:03.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T22:13:51.000Z (3 months ago)
- Last Synced: 2025-01-10T21:06:53.120Z (11 days ago)
- Topics: configuration, kconfig, kernel, rust
- Language: Rust
- Homepage:
- Size: 777 KB
- Stars: 99
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/oddlama/autokernel/blob/main/examples/tutorial.lua)
[](https://crates.io/crates/autokernel)
[](./LICENSE)
# About autokernel
Autokernel is a tool for managing your kernel configuration that guarantees semantic correctness.
It checks symbol assignments for validity by creating a native bridge to the kernel's
Kconfig interface and ensures that your configuration does not silently break during kernel updates.
The next time a config option is removed or renamed, similar to when `CONFIG_THUNDERBOLT` was merged
with `CONFIG_USB4`, you will notice.
It provides a configuration framework which understands the semantics behind symbols,
their dependencies and allowed values and enforces these rules when generating the final
`.config` kernel configuration file. It is able to automatically resolve symbol dependencies
and show useful diagnostics to help you solve configuration errors.
The configuration itself can be written using traditional kconfig files
or by using the more flexible and powerful lua scripting api. This allows for more complex logic
and compatibility with multiple kernel versions. All kernel versions back to `v4.2.0` are supported.
## Installation \& Quickstart
Autokernel can be installed with cargo:
```bash
$ cargo install autokernel
```
Afterwards you will need to create a `/etc/autokernel/config.toml` (for a reference see [examples/config.toml](https://github.com/oddlama/autokernel/blob/main/examples/config.toml)).
Here you can configure which script is used to generate the kernel configuration and how the artifacts
should be installed to your system when using `autokernel build --install`.
```toml
[config]
#script = "/etc/autokernel/legacy.config"
script = "/etc/autokernel/config.lua"
```
Now you can write your kernel configuration. You can either use a classic kconfig file here
(just change the config above as the comment shows), or use the recommended lua interface.
The provided lua API is a more powerful and versatile way to write your configuration.
With it you will be able to create more structured, complex and reusable configurations.
See [tutorial.lua](examples/tutorial.lua) for an introduction to the api. Here's a very small
example `config.lua`:
```lua
-- Begin with the defconfig for your architecture
load_kconfig_unchecked(kernel_dir .. "/arch/x86/configs/x86_64_defconfig")
-- Change some symbols
NET "y"
USB "y"
```
Finally run autokernel to generate a `.config` file. In case your configuration contains any errors,
autokernel will abort and print the relevant diagnostics.
```bash
# Just generate the {kernel_dir}/.config file
$ autokernel generate-config
# Or directly build the whole kernel
$ autokernel build
```
If you want to maintain a package for your favourite distribution, feel free to do so and let us know!
## Introduction
To set a symbol you can use the syntax below.
```lua
-- This will set `CONFIG_NET` to yes.
NET "y"
```
You can also try to assign a value that isn't allowed:
```lua
-- `CONFIG_NET` is a boolean symbol, so mod isn't allowed.
NET "m"
```
The kernel would usually ignore such statements entirely. Autokernel will instead
abort with an error and display diagnostics telling you that only `n` or `y` are allowed:
Kernel options can also only be assigned if they are visible, meaning that their
dependencies must be met. If you try to enable an option that has unmet dependencies,
autokernel will detect that and automatically suggest a solution.
```lua
-- This requires WLAN=y and NETDEVICES=y
WLAN_VENDOR_REALTEK "y"
```
Instead of blindly copying these assignments into your config, you can also invoke the solver directly
from lua. This will only work when the solution is unambiguous, otherwise autokernel will
raise an error and tell you what is missing.
```lua
-- Enable WLAN_VENDOR_REALTEK and any required dependencies
WLAN_VENDOR_REALTEK:satisfy { y, recursive = true }
```
You can also view what you would have to change without provoking an error in your config first
by using `autokernel satisfy --recursive WLAN_VENDOR_REALTEK` as a one-shot command.
There are also some symbols that cannot be set manually, like `RTLWIFI_USB`.
Trying to assign them directly will cause an error:
```lua
RTLWIFI_USB "y"
```
Instead, these need to be enabled by setting another symbol that depends on `RTLWIFI_USB`.
The automatic satisfier is able to solve these aswell, so you can use the same command as
above to find the required assignments or just use `satisfy` directly from lua again:
```lua
RTLWIFI_USB:satisfy { y, recursive = true }
```
Finally you might want to build more complex scripts, which is were lua comes into play.
It will allow you to do conditional assignments like this:
```lua
if kernel_version >= ver("5.6") then
USB4 "y"
else
THUNDERBOLT "y"
end
```
Refer to [tutorial.lua](examples/tutorial.lua) for a thorough introduction to the api.
## Hardening example
For an example configuration for kernel hardening, see [hardening.lua](examples/hardening.lua).