# rustsbi

**Repository Path**: cpdt/rustsbi

## Basic Information

- **Project Name**: rustsbi
- **Description**: RISC-V Supervisor Binary Interface (RISC-V SBI) library in Rust; runs on M or HS mode; good support for embedded Rust ecosystem. For binary download see https://github.com/rustsbi/standalone.
- **Primary Language**: Rust
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-11-18
- **Last Updated**: 2026-09-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RustSBI

RISC-V Supervisor Binary Interface ([SBI](https://github.com/riscv-non-isa/riscv-sbi-doc/)) library in Rust; runs on M-mode or HS mode.

[![crates.io](https://img.shields.io/crates/v/rustsbi.svg)](https://crates.io/crates/rustsbi)
[![Documentation](https://docs.rs/rustsbi/badge.svg)](https://docs.rs/rustsbi)
![License](https://img.shields.io/crates/l/rustsbi.svg)

## Binary downloads

Most users would get RustSBI binary download from the RustSBI Prototyper. Check out the documents [here](https://github.com/rustsbi/rustsbi/tree/main/prototyper)
to build or download images for supported platforms.

Boards, SoC vendors and research groups may sometimes provide dedicated RustSBI package for supported platforms.
There are packages exists on [awesome-rustsbi](https://github.com/rustsbi/awesome-rustsbi): it is a curated list of
awesome things related to RustSBI, which includes some implementation projects maintained by individuals or the community.

Users on commercial boards may visit implementation specific distribution links depending on the platforms they need,
or consult vendors if they provide discrete RustSBI package support.

## Rust toolchain policy

All crates under `library/` support Rust 1.88 or later on their supported targets. Each crate inherits this
minimum supported Rust version (MSRV) from the root [`Cargo.toml`](Cargo.toml). With both the MSRV and current
stable Rust, CI tests the host-compatible libraries, checks every library on RV64IMAC with all features, and checks the
RV32IMAC-compatible libraries on RV32IMAC.

Repository-wide development, including RustSBI Prototyper, uses the date-pinned nightly toolchain in
[`rust-toolchain.toml`](rust-toolchain.toml). `rustup` selects it automatically for commands run in this repository.

## Build this project

### Native development

#### For firmware user

If you need to build RustSBI firmware for M-mode, please refer to the [RustSBI Prototyper](firmware/README.md) documentation.

#### For library user

RustSBI is usually used as a library or dependency. If you wish to, you may build RustSBI library itself using the
following command:

```bash
cargo build
```

The build should finish without any errors.

Building under native platform will allow development of hypervisors and emulators.
To check the libraries on RISC-V with stable Rust, install the target for that toolchain and cross-build:

```bash
rustup target add --toolchain stable riscv64imac-unknown-none-elf
cargo +stable build --locked --target riscv64imac-unknown-none-elf
```

The target platform of RISC-V platform firmware is usually a bare metal target.
Under normal circumstances these targets in Rust would start with `riscv??-` and end with `-none-elf`.

### Or use the Docker development environment

The repository provides a Docker image for development on hosts that do not match the CI environment.
It includes the pinned nightly toolchain, RISC-V targets, QEMU, U-Boot tools and `cargo-binutils`.

For a one-off check, run:

```bash
docker build -t rustsbi-dev .
docker run --rm -v "$PWD:/workspace" -w /workspace rustsbi-dev cargo check
```

For an interactive shell, run:

```bash
docker run --rm -it -v "$PWD:/workspace" -w /workspace rustsbi-dev bash
```

The source tree is mounted at `/workspace`; changes and build artifacts stay on the host.

## Features

- Feature rich and extensible operating system runtime
- Empower support, compatibility for machines, hypervisors and emulators
- Support to and develop with RISC-V SBI specification v2.0 ratified
- Libraries support stable Rust
- Capable to develop with other firmware ecosystem projects
- Adapted for operating system kernel models on your choice
- Included a LLM based Agent module called RustSBI Agent (https://github.com/rustsbi/Agent), which is designed to assist system software developers in their development process

## Frequently asked questions

1. How would I build a RustSBI implementation?

RustSBI have extensive documents on such purposes! No matter what you are building with it, you will find some
documents about RustSBI on bare-metal environments, hypervisors and emulators.

Check it out at [RustSBI document main page](https://docs.rs/rustsbi).

2. Can I use RustSBI on C based kernels?

Yes, you can! RustSBI strictly follows RISC-V SBI standard. All features are prepares for all programming languages,
as long as they support RISC-V SBI defined calling convention.

If your kernel language supports other SBI implementations, usually it will support RustSBI in the same way.

## Talks and documents

This project is originally a part of rCore Summer of Code 2020 activities, inspired
by [MeowSBI](https://github.com/meow-chip/MeowSBI) and other similar projects. Now it is capable of running
rCore-Tutorial and other OS kernels on wide supported RISC-V devices.

There are multiple talks related to RustSBI dated back to Aug 2020. These talks discuss from design and abstraction of
RustSBI modules, to actual production and research usage scenario related to RustSBI and RISC-V bootloaders. Public
slides and blog articles of these talks are available at [RustSBI/slides](https://github.com/rustsbi/slides) page.

## Notes on platform implementation

1. RustSBI should be used as a library. Under normal circumstances, RustSBI platform can be implemented
   with embedded Rust's `embedded-hal` libraries.
2. Contributions are welcomed! We welcome to implement and test RustSBI for both FPGA cores and real cores.
   Implementations for emulators are also welcomed. If you are ready, start your own binary project and use
   RustSBI in it!
3. If there is a bug in RustSBI project itself, fire an issue or pull request to let us know!

## Security

Please see our [Security Policy](SECURITY.md) for information on how to report security vulnerabilities.

## Sponsors

The RustSBI project is sponsored by multiple institutions, companies, and individuals.

Individual sponsors (by order of donation):

| <img src="https://avatars.githubusercontent.com/u/62325246?v=4" width="150" height="150" /> | <img src="https://avatars.githubusercontent.com/u/107762234?v=4" width="150" height="150" /> | <img src="https://avatars.githubusercontent.com/u/54400362?v=4" width="150" height="150" /> |
|---|---|---|
| Chao Liu<br/>([@zevorn](https://github.com/zevorn)) | Zhenchen Wang<br/>([@Plucky923](https://github.com/Plucky923/)) | Zongyao Chen<br/>([@chenzongyao200127](https://github.com/chenzongyao200127)) |

## License & Copyright

This project is licensed under either of

- MIT license ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
- Mulan PSL v2 ([LICENSE-MULAN](LICENSE-MULAN) or [https://opensource.org/licenses/MulanPSL-2.0](https://opensource.org/licenses/MulanPSL-2.0))

Documents from RISC-V SBI Specification are used in this project. These documents are (C) RISC-V Foundation under
Creative Commons Attribution 4.0 International License (CC-BY 4.0). The full license text is available
at https://creativecommons.org/licenses/by/4.0/.