andrey/rCore-Tutorial-v3
1
0
Fork 0
mirror of https://github.com/rcore-os/rCore-Tutorial-v3.git synced 2024-11-25 02:46:23 +04:00
Code Issues Projects Releases Wiki Activity
Let's write an OS which can run on RISC-V in Rust from scratch!
143 Commits 42 Branches 1 Tag 56 MiB
Rust 96.6%
Makefile 1.2%
Assembly 1%
Dockerfile 0.8%
Shell 0.3%
Other 0.1%
95431917ed
Go to file
Yifan Wu 95431917ed Update README.md
2021-07-18 22:50:43 +08:00
bootloader Bump rustsbi to 0.2.0-alpha.1[81d53d8] 2021-04-05 16:29:31 +08:00
easy-fs Fixed a bug that the efs lock was not be held correctly 2021-04-15 12:10:06 +08:00
easy-fs-fuse Merge updates from ch7 2021-02-28 06:38:13 +08:00
os Downgrade cargo-binutils to 0.2.0 2021-04-05 16:29:31 +08:00
user Link small sections in linker 2021-04-05 16:29:31 +08:00
.dockerignore Add Ubuntu18.04 docker 2021-02-28 06:34:15 +08:00
.gitignore Update README.md 2021-07-18 22:50:43 +08:00
Dockerfile Add Ubuntu18.04 docker 2021-02-28 06:34:15 +08:00
LICENSE Initial commit 2020-10-29 15:21:09 +08:00
Makefile Add Ubuntu18.04 docker 2021-02-28 06:34:15 +08:00
README.md Update README.md 2021-07-18 22:50:43 +08:00
rust-toolchain Update os/Makefile && Update rust to 2021-01-30 2021-02-02 18:03:38 +08:00

README.md

rCore-Tutorial-v3

rCore-Tutorial version 3.5. See the Documentation in Chinese.

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.

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 of RefCell or spin::Mutex in order to access static data structures(now ch4 completed)
  • move TaskContext into TaskControlBlock instead of restoring it in place on kernel stack(since ch3), eliminating annoying task_cx_ptr2
  • replace llvm_asm! with asm!(now ch4 completed)

Todo(High priority)

  • adjust API of UPSafeCell so that it cannot be borrowed twice at a time
  • bug fix: we should call find_pte rather than find_pte_create in PageTable::unmap
  • 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.55.0-nightly (2f391da2e 2021-07-14)

  • qemu: 5.0.0

  • rustsbi-lib: 0.2.0-alpha.4

    rustsbi-qemu: d4968dd2

    rustsbi-k210: b689314e

Crates

We will add them later.