Skip to main content

Crate airbender_rt

Crate airbender_rt 

Source
Expand description

§airbender-rt Build status License: MIT OR Apache-2.0 rust nightly required no_std supported

Documentation: API docs | Guest program guide

[!WARNING] airbender-platform project is under active development and is in alpha state. Use at your own risk.

[!NOTE] Support crate. Most guest applications should depend on airbender-sdk instead, which re-exports the runtime, guest API, and codec helpers behind a single dependency.

airbender-rt is the low-level runtime support crate for Airbender guest programs. It handles bootstrapping, allocator setup, syscalls, and UART helpers used by the guest-facing APIs.

§What It Provides

  • start(...) and start_with_allocator_init(...) for guest bootstrapping.
  • Built-in allocator backends for talc and bump allocation, plus hooks for custom allocators.
  • Runtime modules for syscalls, UART output, and getrandom integration.
  • Panic and allocation-error handlers for no_std riscv32 guest builds.

§Features

  • allocator-talc (default), allocator-bump, allocator-custom: select the runtime allocator model.
  • std: enables the small amount of standard-library glue used by std guest builds.

§Usage

Most guest applications should depend on airbender-sdk or airbender-guest. Depend on airbender-rt directly only when you need runtime-level control.

§License

Licensed under either Apache License, Version 2.0 or MIT license at your option.

Re-exports§

pub use boot::start;
pub use boot::start_with_allocator_init;

Modules§

allocator
Guest allocator backends.
boot
Boot helpers for Airbender guest programs.
getrandom
Custom getrandom backend for the Airbender guest environment.
sys
Low-level CSR and exit helpers used by the guest runtime.
uart
UART writer compatible with the existing quasi-uart protocol.