SimpleKernel

📖 目录

✨ 项目简介

🌟 核心亮点

🤖 面向 AI 的设计理念

为什么要"面向 AI"?

┌─────────────────────────────────────────────────────────┐
│ SimpleKernel 学习流程 │
│ │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ 📐 接口 │───▶│ 🤖 AI │───▶│ 🧪 测试 │ │
│ │ 头文件 │ │ 生成实现 │ │ 验证正确性│ │
│ │ + Doxygen │ │ (.cpp) │ │ GoogleTest│ │
│ └──────────┘ └──────────┘ └──────────┘ │
│ │ │ │
│ │ ┌──────────┐ │ │
│ └────────▶│ 📚 参考 │◀─────────┘ │
│ │ 实现对照 │ │
│ └──────────┘ │
└─────────────────────────────────────────────────────────┘

核心工作流

1️⃣ 阅读接口,理解契约

/**
 * @brief 控制台驱动抽象基类
 *
 * 所有串口/控制台驱动必须实现此接口。
 *
 * @pre 硬件已完成基本初始化(时钟使能、引脚配置)
 * @post 调用 PutChar/GetChar 可进行字符级 I/O
 *
 * 已知实现:Ns16550a(RISC-V/x86_64)、Pl011(AArch64)
 */
class ConsoleDriver {
public:
 virtual ~ConsoleDriver() = default;
 virtual void PutChar(uint8_t c) const = 0;
 [[nodiscard]] virtual auto GetChar() const -> uint8_t = 0;
 [[nodiscard]] virtual auto TryGetChar() const -> uint8_t = 0;
};

2️⃣ 让 AI 实现

3️⃣ 测试验证

cmake --preset build_riscv64
cd build_riscv64 && make unit-test

4️⃣ 对照参考实现

与 AI 工具的结合方式

🏛️ 接口体系总览

┌──────────────────────────────────────────┐
│ 应用/系统调用层 │
│ syscall.h · SyscallInit │
├──────────────────────────────────────────┤
│ 任务管理层 │
│ TaskManager · SchedulerBase · Mutex │
│ CfsScheduler · FifoScheduler · RR ... │
├──────────────────────────────────────────┤
│ 内存管理层 │
│ VirtualMemory · PhysicalMemory │
│ MapPage · UnmapPage · AllocFrame │
├──────────────────────────────────────────┤
│ 中断/异常层 │
│ InterruptBase · RegisterInterruptFunc │
│ TimerInit · InterruptInit │
├──────────────────────────────────────────┤
│ 驱动层 │
│ ConsoleDriver · Ns16550a · Pl011 │
│ Gic · Plic · Apic · Timer drivers │
├──────────────────────────────────────────┤
│ 架构抽象层 (arch.h) │
│ ArchInit · InterruptInit · TimerInit │
│ EarlyConsole(全局构造阶段自动设置) │
├──────────────────────────────────────────┤
│ 运行时支持库 │
│ libc (sk_cstdio, sk_cstring, ...) │
│ libcxx (sk_vector, __cxa_*, ...) │
├──────────────────────────────────────────┤
│ 硬件 / QEMU │
│ x86_64 · RISC-V 64 · AArch64 │
└──────────────────────────────────────────┘

关键接口文件

🏗️ 支持架构

🚀 快速开始

📋 系统要求

🛠️ 环境搭建

# 1. 克隆项目
git clone https://github.com/simple-xx/SimpleKernel.git
cd SimpleKernel
git submodule update --init --recursive
# 2. 启动开发环境
docker pull ptrnull233/simple_kernel:latest
docker run --name SimpleKernel-dev -itd -p 233:22 \
 -v $(pwd):/root/SimpleKernel ptrnull233/simple_kernel:latest
# 3. 进入开发容器
docker exec -it SimpleKernel-dev /bin/zsh

⚡ 编译与运行

cd SimpleKernel
# 选择目标架构编译(以 RISC-V 64 为例)
cmake --preset build_riscv64
cd build_riscv64
# 编译内核
make SimpleKernel
# 在 QEMU 模拟器中运行
make run
# 运行单元测试(验证你的实现)
make unit-test

🎯 AI 辅助开发工作流

# 1. 在 VS Code 中打开项目(推荐安装 GitHub Copilot 扩展)
code ./SimpleKernel
# 2. 阅读头文件中的接口定义(例如 src/include/virtual_memory.hpp)
# 3. 创建/编辑对应的 .cpp 文件,让 AI 根据接口生成实现
# 4. 编译验证
cd build_riscv64 && make SimpleKernel
# 5. 运行测试
make unit-test
# 6. 在 QEMU 中运行,观察行为
make run

📂 项目结构

SimpleKernel/
├── src/ # 内核源码
│ ├── include/ # 📐 公共接口头文件(项目核心)
│ │ ├── virtual_memory.hpp # 虚拟内存管理接口
│ │ ├── kernel_fdt.hpp # 设备树解析接口
│ │ ├── kernel_elf.hpp # ELF 解析接口
│ │ ├── spinlock.hpp # 自旋锁接口
│ │ ├── mutex.hpp # 互斥锁接口
│ │ └── ...
│ ├── arch/ # 架构相关代码
│ │ ├── arch.h # 📐 架构无关统一接口
│ │ ├── aarch64/ # AArch64 实现
│ │ ├── riscv64/ # RISC-V 64 实现
│ │ └── x86_64/ # x86_64 实现
│ ├── driver/ # 设备驱动
│ │ ├── include/ # 📐 驱动接口(ConsoleDriver 等)
│ │ ├── ns16550a/ # NS16550A 串口驱动实现
│ │ ├── pl011/ # PL011 串口驱动实现
│ │ └── ...
│ ├── task/ # 任务管理
│ │ ├── include/ # 📐 调度器接口(SchedulerBase 等)
│ │ └── ... # 调度器实现
│ ├── libc/ # 内核 C 标准库
│ └── libcxx/ # 内核 C++ 运行时
├── tests/ # 🧪 测试套件
│ ├── unit_test/ # 单元测试
│ ├── integration_test/ # 集成测试
│ └── system_test/ # 系统测试(QEMU 运行)
├── doc/ # 📚 文档
│ ├── TODO_interface_refactor.md # 接口重构计划
│ └── ...
├── cmake/ # CMake 构建配置
├── 3rd/ # 第三方依赖(Git Submodule)
└── tools/ # 构建工具和模板

🎯 学习路线

阶段 1:基础设施(Boot)

阶段 2:中断系统(Interrupt)

阶段 3:内存管理(Memory)

阶段 4:任务管理(Thread/Task)

阶段 5:系统调用(Syscall)

📦 第三方依赖

📝 开发指南

🎨 代码风格

命名约定

📋 Git Commit 规范

<type>(<scope>): <subject>
type: feat|fix|docs|style|refactor|perf|test|build|revert
scope: 可选,影响的模块 (arch, driver, libc)
subject: 不超过50字符,不加句号

📚 文档

🤝 贡献指南

🎯 贡献方式

🔧 代码贡献流程

📄 许可证

⭐ 如果这个项目对您有帮助,请给我们一个 Star!

🤖 让 AI 帮你写内核,让你专注于理解操作系统原理!

🌟 Star 项目 • 🐛 报告问题 • 💬 参与讨论