Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcdostone/nom-kconfig
A Kconfig parser written in rust.
https://github.com/mcdostone/nom-kconfig
kconfig kernel linux nom parser parsing
Last synced: about 1 month ago
JSON representation
A Kconfig parser written in rust.
- Host: GitHub
- URL: https://github.com/mcdostone/nom-kconfig
- Owner: Mcdostone
- License: mit
- Created: 2023-06-02T22:58:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T10:16:43.000Z (about 1 month ago)
- Last Synced: 2024-10-12T08:03:14.749Z (about 1 month ago)
- Topics: kconfig, kernel, linux, nom, parser, parsing
- Language: Rust
- Homepage: https://crates.io/crates/nom-kconfig
- Size: 392 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Kconfig parser written in rust.
[](https://github.com/Mcdostone/nom-kconfig/actions/workflows/build.yml)
[](https://codecov.io/gh/Mcdostone/nom-kconfig)
[](https://github.com/rust-bakery/nom#rust-version-requirements-msrv)
[](https://crates.io/crates/nom-kconfig)
Kconfig is a language that describes configuration options for the Linux Kernel. The syntax looks like this:
```bash
# https://github.com/torvalds/linux/blob/master/arch/riscv/Kconfig#L771
config EFI
bool "UEFI runtime support"
depends on MMU
default y
select EFI_STUB
help
This option provides support for runtime services provided
by UEFI firmware.
```
- The file starts with a `config` entry: We define a config named `EFI`. The next lines are the attributes of this entry.
- `EFI` is a boolean config.
- `EFI` [depends on](https://www.kernel.org/doc/html/next/kbuild/kconfig-language.html#menu-attributes) the config `MMU`.
- Its default value is `y`.
- If `EFI` is equals to `true` then it enables `EFI_STUB`.
- The `help` attribute defines a help text for the end user.
There are plenty of other keywords in the Kconfig language, check out [the official documentation](https://www.kernel.org/doc/html/next/kbuild/kconfig-language.html) for more details.
**Features**
- This is a parser, there is no semantic analysis in this library.
- This library only supports UTF-8 encoded files.
- List of supported entries can be found [here](https://docs.rs/nom-kconfig/latest/nom_kconfig/entry/enum.Entry.html).
- List of supported attributes can be found [here](https://docs.rs/nom-kconfig/latest/nom_kconfig/attribute/enum.Attribute.html).
- When [`source`](https://www.kernel.org/doc/html/next/kbuild/kconfig-language.html#menu-entries) is met, it reads and parses the specified configuration file.
- This library uses `clone()` a lot. Do not expect amazing performances.
- This parser has been tested on the Linux kernel repository from [2.6.11](https://cdn.kernel.org/pub/linux/kernel/v2.6/linux-2.6.11.tar.xz) to [6.4.9](https://cdn.kernel.org/pub/linux/kernel/v6.x/linux-6.4.9.tar.xz) (3733 versions).
## Getting started
```bash
cargo add nom-kconfig
```
```rust
use std::path::PathBuf;
use nom_kconfig::{parse_kconfig, KconfigInput, KconfigFile};
// curl https://cdn.kernel.org/pub/linux/kernel/v6.x/linux-6.4.9.tar.xz | tar -xJ -C /tmp/
fn main() -> Result<(), Box> {
let kconfig_file = KconfigFile::new(
PathBuf::from("/tmp/linux-6.4.9"),
PathBuf::from("/tmp/linux-6.4.9/Kconfig")
);
let input = kconfig_file.read_to_string()?;
let kconfig = parse_kconfig(KconfigInput::new_extra(&input, kconfig_file));
println!("{:?}", kconfig);
Ok(())
}
```
## Resources
- https://www.kernel.org/doc/html/next/kbuild/kconfig-language.html
- https://doc.coreboot.org/getting_started/kconfig.html
- https://build2.org/libbuild2-kconfig/doc/build2-kconfig-manual.xhtml#lang