riscv-rust

riscv-rust is a RISC-V processor and peripheral devices emulator project written in Rust and compiled to WebAssembly. You can import RISC-V emulator into your Rust or JavaScript project. Refer to the Slides for more detail.

Getting the code

git clone [email protected]:chaoRIOS/riscv-rust.git
cd riscv-rust
git remote add rioslab [email protected]:chaoRIOS/riscv-rust.git
git checkout rioslab/lab1

Setting up VS Code

## Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

## Install components
rustup install nightly  
cargo +nightly install racer
cargo install --force rustfmt
cargo install --force rls

rustup component add rls-preview
rustup component add rust-analysis
rustup component add rust-src

Install VS Code extension Rust with configuring

{
"rust-client.channel": "stable",
    "rust-client.rustupPath": "~/.cargo/bin/rustup",
    "editor.formatOnSave": true,
}

Note: Multiple Rust extensions will be conflicting. Make sure you uninstalled any other Rust extensions.

Toolchain

/opt/riscv-toolchain-bin-imac-9.2.0/bin

---

Documents

• Document

Features

• Emulate RISC-V processor and peripheral devices
• Stable as Linux and xv6-riscv run on it
• Linux OpenSBI and legacy BBL boot support
• Runnable locally
• Also runnable in browser with WebAssembly
• Debugger
• You can import RISC-V emulator into your Rust or JavaScript project

Instructions/Features support status

• RV32/64I
• RV32/64M
• RV32/64F (almost)
• RV32/64D (almost)
• RV32/64Q
• RV32/64A (almost)
• RV64C/32C (almost)
• RV32/64Zifencei (almost)
• RV32/64Zicsr (almost)
• CSR (almost)
• SV32/39
• SV48
• Privileged instructions (almost)
• PMP

etc...

The emulator supports almost all instructions listed above but some instructions which are not used in Linux or xv6 are not implemented yet. Your contribution is very welcome.

How to import into your Rust project

The emulator module is released at crates.io. Add the following line into Cargo.toml of your Rust project.

[dependencies]
riscv_emu_rust = "0.2.0"

Refer to Document for the API.

How to build core library locally

$ git clone https://github.com/takahirox/riscv-rust.git
$ cd riscv-rust
$ cargo build --release

How to run Linux or xv6 as desktop application

$ cd riscv-rust/cli
# Run Linux
$ cargo run --release ../resources/linux/opensbi/fw_payloag.elf -f ../resources/linux/rootfs.img
# Run xv6
$ cargo run --release ../resources/xv6/kernel -f ../resources/xv6/fs.img

How to run riscv-tests

Prerequirements

• Install riscv-gnu-toolchain
• Install riscv-tests

$ cd riscv-rust/cli
$ cargo run $path_to_riscv_tets/isa/rv32ui-p-add -n

How to import and use WebAssembly RISC-V emulator in a web browser

See wasm/web

How to install and use WebAssembly RISC-V emulator npm package

See wasm/npm

Links

Linux RISC-V port

Running 64- and 32-bit RISC-V Linux on QEMU

xv6-riscv

xv6-riscv is the RISC-V port of xv6 which is UNIX V6 rewritten by MIT for x86 in the current C language.

Specifications

• RISC-V ISA
• Virtio Device
• UART
• CLINT, PLIC (SiFive E31 Manual)
• SiFive Interrupt Cookbook