refactor: merge rustsbi repository and prototyper repository (#95)

This pull request merges the rustsbi repository with the prototyper repository.
- Move the rustsbi library files into the `library` directory.
- Merge prototyper into the `prototyper` directory.
- Merge CI and xtask.

Signed-off-by: guttatus <[email protected]>
Signed-off-by: Woshiluo Luo <[email protected]>
Signed-off-by: Zongyao Chen <[email protected]>
Signed-off-by: Nowherechan <[email protected]>
Co-authored-by: Plucky923 <[email protected]>
Co-authored-by: Zhouqi Jiang <[email protected]>

.cargo/config.toml

@@ -0,0 +1,5 @@
+[alias]
+xtask = "run --package xtask --release --"
+prototyper = "xtask prototyper"
+test-kernel = "xtask test"
+bench-kernel = "xtask bench"

.github/workflows/Rust.yml

@@ -45,16 +45,16 @@ jobs:
           key: ${{ matrix.TARGET }}
       - name: Build (no default features)
         run: |
-          cargo build --target ${{ matrix.TARGET }} --verbose
+          cargo build -p rustsbi --target ${{ matrix.TARGET }} --verbose
       - name: Build (machine)
         run: |
-          cargo build --target ${{ matrix.TARGET }} --verbose --features "machine"
+          cargo build -p rustsbi --target ${{ matrix.TARGET }} --verbose --features "machine"
       - name: Build (forward)
         run: |
-          cargo build --target ${{ matrix.TARGET }} --verbose --features "forward"
+          cargo build -p rustsbi --target ${{ matrix.TARGET }} --verbose --features "forward"
       - name: Build (machine + forward)
         run: |
-          cargo build --target ${{ matrix.TARGET }} --verbose --features "machine, forward"
+          cargo build -p rustsbi --target ${{ matrix.TARGET }} --verbose --features "machine, forward"
 
   test-rustsbi:
     name: Test rustsbi

.github/workflows/prototyper.yml

@@ -0,0 +1,50 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# rust-clippy is a tool that runs a bunch of lints to catch common
+# mistakes in your Rust code and help improve your Rust code.
+# More details at https://github.com/rust-lang/rust-clippy
+# and https://rust-lang.github.io/rust-clippy/
+
+name: CI
+
+on:
+  pull_request:
+  push:
+    paths-ignore:
+      - '**.md'
+      - 'LICENSE'
+
+jobs:
+  rust-clippy-analyze:
+    name: Run rust-clippy analyzing
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check format
+        run: cargo fmt --check
+
+      - name: Run test
+        run: |
+            cargo test -p rustsbi-prototyper
+
+      - name: Install required cargo
+        run: cargo install clippy-sarif sarif-fmt
+
+      - name: Run rust-clippy
+        run: |
+          cargo clippy -p rustsbi-prototyper --target riscv64imac-unknown-none-elf  --message-format=json  | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
+          cargo clippy -p rustsbi-test-kernel --target riscv64imac-unknown-none-elf --message-format=json  | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
+          cargo clippy -p rustsbi-bench-kernel --target riscv64imac-unknown-none-elf --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
+        continue-on-error: true
+
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: rust-clippy-results.sarif
+          wait-for-processing: true

Cargo.toml

@@ -1,53 +1,15 @@
-[package]
-name = "rustsbi"
-description = "Minimal RISC-V's SBI implementation library in Rust"
-version = "0.4.0"
-authors = [
-    "Luo Jia <[email protected]>",
-    "Campbell He <[email protected]>",
-    "Yifan Wu <[email protected]>",
-]
-documentation = "https://docs.rs/rustsbi"
-edition.workspace = true
-license.workspace = true
-repository.workspace = true
-readme = "README.md"
-keywords = ["riscv", "sbi", "rustsbi"]
-categories = ["os", "embedded", "hardware-support", "no-std"]
-exclude = ["/.github"]
-
-[dependencies]
-sbi-spec = { version = "0.0.8", path = "sbi-spec" }
-riscv = { version = "0.12.0", optional = true, default-features = false }
-sbi-rt = { version = "0.0.3", features = ["integer-impls"], optional = true, path = "sbi-rt" }
-rustsbi-macros = { version = "0.0.2", path = "macros" }
-
-[features]
-default = []
-# Run RustSBI on machine mode.
-# This feature enables to use RISC-V primitives on current machine mode environment
-# If you are developing a cross-architecture virtual machine, consider disabling this feature
-# to customize environment variables for RISC-V architecture like mvendorid, mimpid, etc.
-machine = ["rustsbi-macros/machine", "dep:riscv"]
-# Enables the struct `Forward`.
-# Struct `Forward` uses the current SBI environment to implement the RustSBI environment.
-# This feature is only usable when current software runs on another SBI environment,
-# e.g., hypervisors for RISC-V architecture.
-forward = ["dep:sbi-rt"]
-
-[package.metadata.docs.rs]
-default-target = "riscv64imac-unknown-none-elf"
-targets = [
-    "riscv32imac-unknown-none-elf", "riscv64imac-unknown-none-elf",
-]
-
 [workspace]
 resolver = "2"
 members = [
-    "macros",
-    "sbi-rt",
-    "sbi-spec",
-    "sbi-testing",
+    "library/macros",
+    "library/sbi-rt",
+    "library/sbi-spec",
+    "library/sbi-testing",
+    "library/rustsbi",
+    "prototyper/prototyper",
+    "prototyper/bench-kernel",
+    "prototyper/test-kernel",
+    "xtask",
 ]
 
 [workspace.package]
@@ -55,4 +17,6 @@ edition = "2024"
 license = "MulanPSL-2.0 OR MIT"
 repository = "https://github.com/rustsbi/rustsbi"
 
+[profile.release]
+debug = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

macros/Cargo.toml → library/macros/Cargo.toml

@@ -9,7 +9,7 @@ documentation = "https://docs.rs/rustsbi"
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-readme = "../README.md"
+readme = "../../README.md"
 keywords = ["riscv", "sbi", "rustsbi"]
 categories = ["os", "embedded", "hardware-support", "no-std"]
 

library/rustsbi/Cargo.toml

@@ -0,0 +1,43 @@
+[package]
+name = "rustsbi"
+description = "Minimal RISC-V's SBI implementation library in Rust"
+version = "0.4.0"
+authors = [
+    "Luo Jia <[email protected]>",
+    "Campbell He <[email protected]>",
+    "Yifan Wu <[email protected]>",
+]
+documentation = "https://docs.rs/rustsbi"
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+readme = "../../README.md"
+keywords = ["riscv", "sbi", "rustsbi"]
+categories = ["os", "embedded", "hardware-support", "no-std"]
+
+[dependencies]
+sbi-spec = { version = "0.0.8", path = "../sbi-spec" }
+riscv = { version = "0.12.0", optional = true, default-features = false }
+sbi-rt = { version = "0.0.3", features = ["integer-impls"], optional = true, path = "../sbi-rt" }
+rustsbi-macros = { version = "0.0.2", path = "../macros" }
+
+[features]
+default = []
+# Run RustSBI on machine mode.
+# This feature enables to use RISC-V primitives on current machine mode environment
+# If you are developing a cross-architecture virtual machine, consider disabling this feature
+# to customize environment variables for RISC-V architecture like mvendorid, mimpid, etc.
+machine = ["rustsbi-macros/machine", "dep:riscv"]
+# Enables the struct `Forward`.
+# Struct `Forward` uses the current SBI environment to implement the RustSBI environment.
+# This feature is only usable when current software runs on another SBI environment,
+# e.g., hypervisors for RISC-V architecture.
+forward = ["dep:sbi-rt"]
+
+[package.metadata.docs.rs]
+default-target = "riscv64imac-unknown-none-elf"
+targets = [
+    "riscv32imac-unknown-none-elf", "riscv64imac-unknown-none-elf",
+]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

sbi-testing/src/thread.rs → library/sbi-testing/src/thread.rs

@@ -147,7 +147,7 @@ unsafe extern "C" fn execute_naked() {
             SAVE_ALL
         ",
             // 设置陷入入口
-            "   la   t0, 1f
+            "   la   t0, 2f
             csrw stvec, t0
         ",
             // 保存调度上下文地址并切换上下文
@@ -164,7 +164,7 @@ unsafe extern "C" fn execute_naked() {
             // 陷入
             "   .align 2",
             // 切换上下文
-            "1: csrrw sp, sscratch, sp",
+            "2: csrrw sp, sscratch, sp",
             // 保存线程上下文
             "   SAVE_ALL
             csrrw t0, sscratch, sp

sbi-testing/src/time.rs → library/sbi-testing/src/time.rs

@@ -52,13 +52,13 @@ pub fn test(delay: u64, mut f: impl FnMut(Case)) {
     let mut ok = 0xffusize;
     unsafe {
         core::arch::asm!(
-            "   la   {stvec}, 1f
+            "   la   {stvec}, 2f
                 csrw stvec,   {stvec}
                 csrr {begin}, time
                 csrr {end},   time
                 mv   {ok},    zero
             .align 2
-            1:
+            2:
             ",
             stvec = out(reg) _,
             begin = out(reg) begin,

prototyper/.pre-commit-config.yaml

@@ -0,0 +1,87 @@
+fail_fast: false
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        description: Format files with rustfmt.
+        entry: bash -c 'cargo fmt -- --check'
+        language: rust
+        files: \.rs$
+        args: []
+      - id: typos
+        name: typos
+        description: check typo
+        entry: bash -c 'typos'
+        language: rust
+        files: \.*$
+        pass_filenames: false
+      - id: cargo-check
+        name: cargo check
+        description: Check the package for errors.
+        entry: |
+          bash -c '
+            # Get all packages in the workspace
+            packages=$(cargo metadata --format-version 1 | jq -r ".packages[] | select(.name != \"xtask\") | .name")
+
+            # Check each package
+            for package in $packages; do
+              echo "Checking package: $package"
+              cargo check -p "$package" --target riscv64imac-unknown-none-elf
+              check_status=$?
+
+              # If the check fails, exit with the error code
+              if [ "$check_status" -ne 0 ]; then
+                echo "Package $package check failed, exit status: $check_status!"
+                exit $check_status
+              fi
+            done
+
+            echo "All packages checked successfully."
+            exit 0
+          '
+        language: rust
+        files: \.rs$
+        pass_filenames: false
+      - id: cargo-clippy
+        name: cargo clippy
+        description: Lint Rust sources.
+        entry: |
+          bash -c '
+            # Get all packages in the workspace
+            packages=$(cargo metadata --format-version 1 | jq -r ".packages[] | select(.name != \"xtask\") | .name")
+
+            # Lint each package
+            for package in $packages; do
+              echo "Linting package: $package"
+              cargo clippy -p "$package" --target riscv64imac-unknown-none-elf -- -D warnings
+              clippy_status=$?
+
+              # If the linting fails, exit with the error code
+              if [ "$clippy_status" -ne 0 ]; then
+                echo "Package $package clippy check failed, exit status: $clippy_status!"
+                exit $clippy_status
+              fi
+            done
+
+            echo "All packages linted successfully."
+            exit 0
+          '
+        language: rust
+        files: \.rs$
+        pass_filenames: false

prototyper/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
+
+---
+## [unreleased]

prototyper/README.md

@@ -0,0 +1,56 @@
+# RustSBI Prototyper
+
+RustSBI Prototyper is a developing RISC-V Secure Bootloader solution. It can be integrated with the Rust or C language ecosystem to form a complete RISC-V bootloader ecosystem.
+
+## Setting Up the Development Environment
+
+### Packages to be installed
+
+```bash
+cargo install cargo-binutils
+sudo apt install u-boot-tools
+```
+
+
+### Optional Tools
+
+The following tools are not mandatory but can be useful for enhancing your development experience.
+
+#### Install pre-commit
+
+pre-commit is a tool that runs code checks before you commit your code.
+
+```bash
+pipx install pre-commit
+
+# After installation, run pre-commit install to set it up for your project.
+pre-commit install
+```
+
+#### Install Cargo Deny
+
+Cargo deny is a Cargo plugin used to check the security of your dependencies.
+
+```bash
+cargo install --locked cargo-deny
+```
+
+#### Install typos
+
+typos is a spell-checking tool.
+
+```bash
+cargo install typos-cli
+```
+
+#### Install git cliff
+
+git cliff is a tool for generating changelogs.
+
+```bash
+cargo install git-cliff
+```
+
+## License
+
+This project is dual-licensed under MIT or Mulan-PSL v2. See [LICENSE-MIT](./LICENSE-MIT) and [LICENSE-MULAN](./LICENSE-MULAN) for details.

prototyper/_typos.toml

@@ -0,0 +1,7 @@
+[default.extend-words]
+rela = "rela"
+sie = "sie"
+stip = "stip"
+
+[files]
+extend-exclude = ["CHANGELOG.md"]