mirror of
https://github.com/rcore-os/rCore-Tutorial-v3.git
synced 2024-11-22 01:16:26 +04:00
Let's write an OS which can run on RISC-V in Rust from scratch!
bootloader | ||
easy-fs | ||
easy-fs-fuse | ||
os | ||
user | ||
.dockerignore | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
rust-toolchain |
rCore-Tutorial-v3
rCore-Tutorial version 3.5. See the Documentation in Chinese.
news
- 2021.07.29: Now we are updating our labs. Please checkout chX-dev Branches for our current new labs. (Notice: please see the [Dependency] section in the end of this doc)
Overview
This project aims to show how to write an Unix-like OS running on RISC-V platforms from scratch in Rust for beginners without any background knowledge about computer architectures, assembly languages or operating systems.
Features
- Platform supported:
qemu-system-riscv64
simulator or dev boards based on Kendryte K210 SoC such as Maix Dock - OS
- concurrency of multiple processes
- preemptive scheduling(Round-Robin algorithm)
- dynamic memory management in kernel
- virtual memory
- a simple file system with a block cache
- an interactive shell in the userspace
- only 4K+ LoC
- A detailed documentation in Chinese in spite of the lack of comments in the code(English version is not available at present)
Run our project
TODO:
Working in progress
Now we are still updating our project, you can find latest changes on branches chX-dev
such as ch1-dev
. We are intended to publish first release 3.5.0 after completing most of the tasks mentioned below.
Overall progress: ch7
Completed
- automatically clean up and rebuild before running our project on a different platform
- fix
power
series application in early chapters, now you can find modulus in the output - use
UPSafeCell
instead ofRefCell
orspin::Mutex
in order to access static data structures and adjust its API so that it cannot be borrowed twice at a time(mention& .exclusive_access().task[0]
inrun_first_task
) - move
TaskContext
intoTaskControlBlock
instead of restoring it in place on kernel stack(since ch3), eliminating annoyingtask_cx_ptr2
- replace
llvm_asm!
withasm!
- expand the fs image size generated by
rcore-fs-fuse
to 128MiB - add a new test named
huge_write
which evaluates the fs performance(qemu~500KiB/s k210~50KiB/s) - flush all block cache to disk after a fs transaction which involves write operation
Todo(High priority)
- bug fix: we should call
find_pte
rather thanfind_pte_create
inPageTable::unmap
- bug fix: check validity of level-3 pte in
find_pte
instead of checking it outside this function - use old fs image optionally, do not always rebuild the image
- replace
spin::Mutex
withUPSafeCell
before SMP chapter - add new system calls: getdents64/fstat
- shell functionality improvement(to be continued...)
- add a new chapter about synchronization & mutual exclusion(uniprocessor only)
- give every non-zero process exit code an unique and clear error type
- effective error handling of mm module
Todo(Low priority)
- rewrite practice doc and remove some inproper questions
- provide smooth debug experience at a Rust source code level
- format the code using official tools
- support Allwinner's RISC-V D1 chip
Dependency
Binaries
-
rustc 1.56.0-nightly (08095fc1f 2021-07-26)
-
qemu: 5.0.0
-
rustsbi-lib: 0.2.0-alpha.4
rustsbi-qemu: d4968dd2
rustsbi-k210: b689314e
Crates
We will add them later.