rCore/README.md

rCore

Rust version of THU uCore OS Plus.

Going to be the next generation teaching operating system.

Supported architectures and boards:

• x86_64: PC (i5/i7)
• RISCV32/64: HiFive Unleashed, Kendryte K210, FPGA running Rocket Chip
• AArch64: Raspberry Pi 3B+
• MIPS32: TrivialMIPS

Building

Environment

• Rust toolchain
• Cargo tools: cargo-xbuild
• QEMU >= 3.1.0
• musl-based GCC toolchains

See Travis script for details.

How to run

$ rustup component add rust-src llvm-tools-preview
$ cargo install cargo-binutils
$ cargo install cargo-xbuild

$ git clone https://github.com/rcore-os/rCore.git --recursive
$ cd rCore/user
$ make sfsimg arch={riscv32,riscv64,x86_64,aarch64,mipsel} # requires $(arch)-linux-musl-gcc
$ cd ../kernel
$ make run arch={riscv32,riscv64,x86_64,aarch64,mipsel} mode=release
$ make run arch=x86_64 mode=release pci_passthru=0000:00:00.1 # for ixgbe real nic, find its pci (bus, dev, func) first

Maintainers

Module	Maintainer
x86_64	@wangrunji0408
RISC-V	@jiegec
ARM (Raspi3)	@equation314
MIPS	@Harry_Chen @miskcoo
Memory, Process, File System	@wangrunji0408
Network with drivers	@jiegec
GUI	@equation314

History

This is a project of THU courses:

• Operating System (2018 Spring)
• Comprehensive Experiment of Computer System (2018 Summer)
• Operating System Train (2018 Autumn)
• Operating System (2019 Spring)
• Operating System Train (2019 Autumn)

Reports and Dev docs (in Chinese)

It's based on BlogOS , a demo project in the excellent tutorial Writing an OS in Rust (First Edition).

License

The source code is dual-licensed under MIT or the Apache License (Version 2.0).