UltraOS

拥有友好代码和详细文档的Rust编写的基于RISC-V64的多核操作系统UltraOS，支持qemu和k210平台运行。

UltraOS: A RISC-V multicore operating system that is written by Rust language in qemu and k210 platform.

当前，由于兼容问题，我们更新了项目的版本管理，将工具链以及重要的外部库进行了锁定。需要注意的是，最后的展示结果将会出现部分错误，这是正常的，因为项目人员技术水平问题，顾此失彼，支持了更高级的功能，但并未进行回归测试保证全方面功能正确。但是已知问题都是容易解决的，不会对架构及其实现产生影响。

移步到 https://gitee.com/LoanCold/ultraos_backup 拉取完整的代码，并且在那个gitee仓库里保存有我们开发的全过程commits和21个不同的分支，感谢支持！但是，gitee上并不会与本Github项目进行代码同步，本项目为最终维护项目。

Complete code repository is at https://gitee.com/LoanCold/ultraos_backup. However, the source code there is not synced. The Github repository here is the official version now.

联系我们 Contact Us

李程浩：loancold@qq.com

宫浩辰：1527198893@qq.com

任翔宇：lewaysfca73@gmail.com

快速上手 Quick Start

确保您已经安装qemu-system-riscv64 (may done through sudo apt install qemu-system-riscv64) 以及Rust组件。在根目录下，输入以下命令。

make env # Install required environment. If it succeeds, you don't need to do it again.
make run # Prepare neccessaray components and compilation, then run UltraOS in qemu.
# Later you will enter UltraOS shell, then type:
root@UltraOS: / >>run_testsuites

然后你将会看到UltraOS自动运行21年首届**本科生OS竞赛内核赛道初试的测试样例。

如果你的电脑没有安装OpenSBI，或许会出现opensbi-riscv64-virt-fw_jump.bin文件无法找到的问题。或者当你遇到其他的问题使得没有正常进入UltraOS命令行界面，此时你可以修改codes/os/Makefile line 25-27 挑选其他SBI使用。但是功能将不会正常，因为老版本RustSBI无法启用浮点，无法通过许多测试，新版本则存在兼容问题。但是k210上不存在这种情况，可放心使用。

	BOOTLOADER := default
#	BOOTLOADER := ../bootloader/$(SBI)-$(BOARD).bin # If you have no OpenSBI, try RustSBI.
#	BOOTLOADER := ../bootloader/$(SBI)-$(BOARD)-new.bin # If you want to use new RustSBI, try this.

如果你想修改Shell，见codes/user/src/bin/user_shell.rs。如果你想修改内核，见codes/os/src/main.rs。

运行

根目录下Makefile提供了两个命令。

Makefile provides two make commands under the root directory.

make all

该命令将生成完整的二进制内核文件，可烧录至k210开发板上。该命令会编译内核文件，与SBI拼接后生成裸运行文件k210.bin放置在根目录。

This would build the kernel binary file, which can run on the Kendryte K210 embedded SoC.

make run

该命令将直接在qemu上运行UltraOS。该命令会首先编译我们准备好的测试代码，之后将其程序以及我们所参加的操作系统大赛给出的官方测试文件一同烧录到我们准备的文件镜像中，然后开始编译内核文件，与SBI拼接后生成裸运行文件，通过qemu运行。注意，我们虽然与RustSBI进行合并，但是最后我们并没有使用它，而是换成了OpenSBI，因为RustSBI在qemu下没有开启浮点运算，在k210平台则继续使用了RustSBI（UltraOS定制版本）。

This would run the OS kernel directly on Qemu.

make run BOARD=k210

该命令将生成内核文件，并且直接在k210上运行UltraOS。但是，为了能够运行更多的程序，请在k210上插入sd卡，并在里面放置预备文件和程序，UltraOS会将其作为文件系统控制的外存进行使用。同时，需要注意的是，为了支持比赛的进行，我们的UltraOS会自行运行

This command will build the kernel binary file and run it directly on the Kendryte K210 embedded SoC.

make gdb

make monitor

这一组命令分别在两个窗口运行，即可启动gdb调试。

Run these two commands separately in two shells; then the GDB debugging can start.

项目人员

来自哈尔滨工业大学（深圳）

李程浩（队长）：主要负责多核支持，进程管理以及内存一致性管理，用户程序支持，开发和测试环境搭建。

宫浩辰：主要负责FAT和EXT2-like虚拟文件系统及其内核支持，联合调试，k210开发板以及SBI支持，多核支持。

任翔宇：主要负责内存管理以及优化，trap设计。

项目特征

Rust语言
多核操作系统
支持59条系统调用
高性能优化：内存弱一致性优化、lazy与CoW、文件系统双文件块缓存等优化等机制
信号机制：进程支持进程信号软中断。
支持C语言程序和Rust语言用户程序编写和运行（提供回归测试基础）
FAT32虚拟文件系统
混合调试工具：Monitor（结合静态宏打印以及动态gdb特性）
详细项目文档、开发过程支持以及理解友好型代码构造和注释

文件包阅读说明

doc：项目文档
codes：开发代码
- bootloader：使用开发者洛佳的K210和qemu版本的RustSBI二进制文件（本项目对源码进行了改动，生成的二进制文件不为官方版本）
- dependency：本地库依赖
- fat32-fuse：构建fat32文件系统
- os：kernel代码
- riscv-syscalls-testing：官方评测程序
- simple_fat32：fat32文件系统，隶属于kernel
- user：用户程序相关

感谢与声明

本项目使用了洛佳等开发者的RustSBI 2021.03.26版本，以及吴一凡等开发者的rCoreTutorial-v3 2021.03.26版本。

同时感谢哈尔滨工业大学（深圳）的黎庚祉同学给予的帮助和灵感，以及夏文老师和江仲鸣老师在进度上的跟踪。

本项目使用GPL3.0协议，欢迎开发者使用该项目进行学习。

Lines of Code

Codes from us or from prototypes UltraOS based on.

| path | files | code | comment | blank | total |
| user/src | 30 | 1,811 | 129 | 241 | 2,181 |
| fat32-fuse | 7 | 573 | 44 | 72 | 689 |
| simple_fat32 | 10 | 2,241 | 407 | 241 | 2,889 |
| os | 59 | 8,099 | 1,466 | 979 | 10,544 |

Pure Code: 12724 Total: 16303

xiyurain/UltraOS