Initial commit

Author: equation314

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        rust-toolchain: [nightly]
+        targets: [x86_64-unknown-linux-gnu, x86_64-unknown-none, riscv64gc-unknown-none-elf, aarch64-unknown-none-softfloat]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dtolnay/rust-toolchain@nightly
+      with:
+        toolchain: ${{ matrix.rust-toolchain }}
+        components: rust-src, clippy, rustfmt
+        targets: ${{ matrix.targets }}
+    - name: Check rust version
+      run: rustc --version --verbose
+    - name: Check code format
+      run: cargo fmt --all -- --check
+    - name: Clippy
+      run: cargo clippy --target ${{ matrix.targets }} --all-features -- -A clippy::new_without_default
+    - name: Build
+      run: cargo build --target ${{ matrix.targets }} --all-features
+    - name: Unit test
+      if: ${{ matrix.targets == 'x86_64-unknown-linux-gnu' }}
+      run: cargo test --target ${{ matrix.targets }} -- --nocapture
+
+  doc:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    permissions:
+      contents: write
+    env:
+      default-branch: ${{ format('refs/heads/{0}', github.event.repository.default_branch) }}
+      RUSTDOCFLAGS: -D rustdoc::broken_intra_doc_links -D missing-docs
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dtolnay/rust-toolchain@nightly
+    - name: Build docs
+      continue-on-error: ${{ github.ref != env.default-branch && github.event_name != 'pull_request' }}
+      run: |
+        cargo doc --no-deps --all-features
+        printf '<meta http-equiv="refresh" content="0;url=%s/index.html">' $(cargo tree | head -1 | cut -d' ' -f1) > target/doc/index.html
+    - name: Deploy to Github Pages
+      if: ${{ github.ref == env.default-branch }}
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        single-commit: true
+        branch: gh-pages
+        folder: target/doc

.gitignore

@@ -0,0 +1,5 @@
+/target
+/.vscode
+.DS_Store
+Cargo.lock
+.axconfig.toml

Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "axconfig_gen"
+version = "0.1.0"
+edition = "2021"
+authors = ["Yuekai Jia <equation618@gmail.com>"]
+description = "A TOML-based configuration generator for ArceOS"
+license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
+homepage = "https://github.com/arceos-org/arceos"
+repository = "https://github.com/arceos-org/axconfig_gen"
+documentation = "https://docs.rs/axconfig_gen"
+keywords = ["arceos", "config", "toml"]
+categories = ["config", "parsing", "parser-implementations"]
+
+[dependencies]
+toml_edit = { version = "0.22" }
+clap = { version = "4", features = ["derive"] }
+
+[[bin]]
+name = "axconfig-gen"

README.md

@@ -0,0 +1 @@
+# axconfig-gen

example_configs/defconfig.toml

@@ -0,0 +1,62 @@
+# Architecture identifier.
+arch = "x86_64"             # str
+# Platform identifier.
+plat = "x86_64-qemu-q35"    # str
+# Number of CPUs
+smp = 1                     # uint
+
+#
+# Kernel configs
+#
+[kernel]
+# Stack size of each task.
+task-stack-size = 0     # uint
+# Number of timer ticks per second (Hz). A timer tick may contain several timer
+# interrupts.
+ticks-per-sec = 0       # uint
+
+#
+# Platform configs
+#
+[platform]
+# Base address of the whole physical memory.
+phys-memory-base = 0                # uint
+# Size of the whole physical memory.
+phys-memory-size = 0x800_0000       # uint
+# Base physical address of the kernel image.
+kernel-base-paddr = 0x20_0000       # uint
+# Base virtual address of the kernel image.
+kernel-base-vaddr = "0xffff_ff80_0020_0000"     # uint
+# Linear mapping offset, for quick conversions between physical and virtual
+# addresses.
+phys-virt-offset = "0xffff_ff80_0000_0000"      # uint
+# Offset of bus address and phys address. some boards, the bus address is
+# different from the physical address.
+phys-bus-offset = 0                             # uint
+# Kernel address space base.
+kernel-aspace-base = "0xffff_ff80_0000_0000"    # uint
+# Kernel address space size.
+kernel-aspace-size = "0x0000_007f_ffff_f000"    # uint
+# Timer interrupt frequencyin Hz.
+timer-frequency = 0                             # uint
+
+#
+# Device specifications
+#
+[device]
+# MMIO regions with format (`base_paddr`, `size`).
+mmio-regions = [
+    ["0xb000_0000", "0x1000_0000"], # PCI config space
+    ["0xfe00_0000", "0xc0_0000"],   # PCI devices
+    ["0xfec0_0000", "0x1000"],      # IO APIC
+    ["0xfed0_0000", "0x1000"],      # HPET
+    ["0xfee0_0000", "0x1000"],      # Local APIC
+]                           # [(uint, uint)]
+# VirtIO MMIO regions with format (`base_paddr`, `size`).
+virtio-mmio-regions = []    # [(uint, uint)]
+# Base physical address of the PCIe ECAM space (should read from ACPI 'MCFG' table).
+pci-ecam-base = 0           # uint
+# End PCI bus number.
+pci-bus-end = 0             # uint
+# PCI device memory ranges (not used on x86).
+pci-ranges = []             # [(uint, uint)]

src/bin/axconfig-gen.rs

@@ -0,0 +1,50 @@
+use std::io;
+
+use axconfig_gen::Config;
+use clap::Parser;
+
+#[derive(Parser, Debug)]
+#[command(version, about, long_about = None)]
+struct Args {
+    /// Path to the config specification file
+    #[arg(short, long, required = true)]
+    spec: Vec<String>,
+
+    /// Path to the old config file
+    #[arg(short = 'c', long)]
+    oldconfig: Option<String>,
+
+    /// Path to the output config file
+    #[arg(short, long)]
+    output: Option<String>,
+}
+
+fn main() -> io::Result<()> {
+    let args = Args::parse();
+
+    let mut defconfig = Config::new();
+    for spec in args.spec {
+        let spec_toml = std::fs::read_to_string(spec)?;
+        let sub_config = Config::from_toml(&spec_toml).unwrap();
+
+        defconfig.merge(&sub_config).unwrap();
+    }
+
+    let output_config = if let Some(oldconfig_path) = args.oldconfig {
+        let oldconfig_toml = std::fs::read_to_string(oldconfig_path)?;
+        let oldconfig = Config::from_toml(&oldconfig_toml).unwrap();
+        defconfig.update(&oldconfig).unwrap();
+        defconfig
+    } else {
+        defconfig
+    };
+
+    let output = output_config.gen_toml().unwrap();
+    if let Some(path) = args.output {
+        std::fs::write(path, output)?;
+    } else {
+        println!("{}", output);
+    }
+
+    Ok(())
+}