Merge pull request #29 from miiyakumo/main Closes #21

格式化代码并在ci中引入代码检查

Author: miiyakumo

.github/workflows/test.yml .github/workflows/ci.yml.github/workflows/test.yml renamed to .github/workflows/ci.yml

@@ -1,13 +1,19 @@
-name: Run tests
+name: Run tests & Code Quality Checks
 
-on: [push]
+on:
+  push:
+    branches:
+      - main  # 在代码合并到 main 分支后，仍然运行一次完整的 CI
+  pull_request:
+    branches:
+      - main  # 在针对 main 分支的 PR 提出/更新时运行 CI
 
 env:
   CARGO_TERM_COLOR: always
-  RUST_TOOLCHAIN: nightly-2025-01-13 
-
-  QEMU_VERSION: qemu-9.2.1 
-  QEMU_BUILD_PATH: ${{ github.workspace }}/qemu-build-cache 
+  RUST_TOOLCHAIN: nightly-2025-01-13
+  
+  QEMU_VERSION: qemu-9.2.1
+  QEMU_BUILD_PATH: ${{ github.workspace }}/qemu-build-cache
 
 jobs:
   run-tests:
@@ -16,29 +22,55 @@ jobs:
       - name: ⬇️ Checkout code
         uses: actions/checkout@v4
 
-      # --- 1. 缓存 Cargo 依赖项 ---
-      - name: 📦 Cache Cargo Dependencies & Build Artifacts
-        uses: actions/cache@v4
+      # --- 1. 缓存 Cargo 依赖项 (使用 Swatinem/rust-cache) ---
+      # ⚠️ 替换了原有的 actions/cache@v4，更高效地管理 Cargo 缓存
+      - name: 📦 Setup Rust Cache
+        uses: Swatinem/rust-cache@v2
         with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target
-          key: ${{ runner.os }}-cargo-${{ env.RUST_TOOLCHAIN }}-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-${{ env.RUST_TOOLCHAIN }}-
+          # 仅需传递 key 相关的变量，该 Action 会自动处理路径
+          key: ${{ runner.os }}-${{ env.RUST_TOOLCHAIN }}-${{ hashFiles('**/Cargo.lock') }}
 
       # --- 2. 安装 Rust Toolchain 和 Target ---
       - name: 🛠️ Setup Rust Toolchain and Target
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.RUST_TOOLCHAIN }} 
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
           targets: riscv64gc-unknown-none-elf
+          # 确保安装了 rustfmt 和 clippy
           components: rust-src, rustfmt, clippy, llvm-tools-preview
 
+      # --- 2.1 代码质量检查 (优先执行) ---
+
+      - name: 🔍 Cargo Check (快速验证编译)
+        working-directory: os
+        run: cargo check --target riscv64gc-unknown-none-elf
+
+      - name: 📏 Run Code Formatting Check
+        working-directory: os
+        # 使用 --check 模式，如果代码未格式化，则 CI 失败
+        run: cargo fmt --all -- --check
+
+      - name: 🔬 Run Clippy Lint Check
+        working-directory: os
+        # 使用 -D warnings 强制将所有警告升级为错误，确保 PR 必须解决所有代码异味
+        run: cargo clippy --target riscv64gc-unknown-none-elf -- -D warnings
+        
+      # --- 2.2 安装辅助工具 ---
+
       - name: Install cargo-binutils
         run: cargo install cargo-binutils
 
+      # --- 2.5 缓存 Apt 包 (优化 QEMU 依赖安装时间) ---
+      - name: 📦 Cache APT Dependencies
+        uses: actions/cache@v4
+        with:
+          path: |
+            /var/cache/apt/archives
+            /var/lib/apt/lists
+          key: ${{ runner.os }}-apt-qemu-deps-v1
+          restore-keys: |
+            ${{ runner.os }}-apt-qemu-deps-
+            
       # --- 3. QEMU 编译和缓存 ---
       - name: 🧱 Install QEMU Dependencies
         run: |

document/README.md

@@ -0,0 +1 @@
+在这个文件夹里记录一些模块设计思路和硬件细节

document/Task.md

@@ -0,0 +1,6 @@
+# 进程模块的设计
+
+## 概要
+总体而言，我准备效仿Linux，将其称为Task并对于进程线程不加以区分，即认为：
+
+**线程不过是与别的Task共享某些资源的Task**

os/src/arch/loongarch/mod.rs

@@ -1 +1 @@
-mod mm;
+mod mm;

os/src/arch/mod.rs

@@ -5,4 +5,4 @@ mod riscv;
 pub use self::loongarch::*;
 
 #[cfg(target_arch = "riscv64")]
-pub use riscv::*;
+pub use riscv::*;

os/src/arch/riscv/constant.rs

@@ -1,3 +1,3 @@
 #![allow(unused)]
 /// riscv sstatus 寄存器中 SIE 位的掩码
-pub const SSTATUS_SIE: usize = 1 << 1;
+pub const SSTATUS_SIE: usize = 1 << 1;

os/src/arch/riscv/intr/mod.rs

@@ -1,5 +1,8 @@
 #![allow(unused)]
-use riscv::register::{sie, sstatus::{self, Sstatus}};
+use riscv::register::{
+    sie,
+    sstatus::{self, Sstatus},
+};
 
 /// 启用定时器中断
 pub unsafe fn enable_timer_interrupt() {
@@ -47,4 +50,4 @@ pub unsafe fn read_and_disable_interrupts() -> usize {
 pub unsafe fn restore_interrupts(flags: usize) {
     // XXX: 与 read_and_disable_interrupts 配合使用时，中断禁用期间其它并发可能会改变寄存器状态，此时要恢复它们吗？
     unsafe { sstatus::write(Sstatus::from_bits(flags)) };
-}
+}

os/src/arch/riscv/kernel/context.rs

@@ -1,10 +1,11 @@
 /// 在发生调度时保存的上下文信息
 /// 相较于TrapFram只保存切换所需的最少量寄存器
+#[allow(dead_code)]
 pub struct Context {
     /// 返回地址
     pub ra: usize,
     /// 栈指针
     pub sp: usize,
     /// 保存s0-s11寄存器
     pub s: [usize; 12],
-}
+}

os/src/arch/riscv/kernel/mod.rs

@@ -1 +1 @@
-pub mod context;
+pub mod context;

os/src/arch/riscv/mm/mod.rs

@@ -61,4 +61,4 @@ pub const fn vaddr_to_paddr(vaddr: usize) -> usize {
 /// This function must be implemented in all architecture-specific mm modules.
 pub const fn paddr_to_vaddr(paddr: usize) -> usize {
     paddr | VADDR_START
-}
+}