Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Yuke Peng 8e210c2241 Add ktest array to riscv64 linker 2024-10-08 11:47:01 +08:00
.github
.vscode
docs doc: improve grammar, spelling, and fix some links 2024-10-01 15:24:12 +08:00
kernel Use `LocalIrqDisable` in `Subject` 2024-10-04 21:55:48 +08:00
osdk Add ktest array to riscv64 linker 2024-10-08 11:47:01 +08:00
ostd Use `node::Entry` to optimize page table cursor operations 2024-10-06 17:15:41 +08:00
test
tools Disbale dumping network packets 2024-10-08 10:50:38 +08:00
.code-workspace
.dockerignore
.gitignore
.licenserc.yaml
.typos.toml
COPYRIGHT
Cargo.lock
Cargo.toml
Components.toml
LICENSE-MPL
Makefile Make sure ktest finishes without aborts 2024-10-06 17:15:41 +08:00
OSDK.toml Remove unused field in OSDK config file 2024-10-04 10:08:03 +08:00
README.md
README_CN.md
VERSION
rust-toolchain.toml
rustfmt.toml
triagebot.toml

README.md

asterinas-logo
A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux
Test OSDK Test Asterinas Benchmark Asterinas

English | 中文版

Introducing Asterinas

Asterinas is a secure, fast, and general-purpose OS kernel that provides Linux-compatible ABI. It can serve as a seamless replacement for Linux while enhancing memory safety and developer friendliness.

  • Asterinas prioritizes memory safety by employing Rust as its sole programming language and limiting the use of unsafe Rust to a clearly defined and minimal Trusted Computing Base (TCB). This innovative approach, known as the framekernel architecture, establishes Asterinas as a more secure and dependable kernel option.

  • Asterinas surpasses Linux in terms of developer friendliness. It empowers kernel developers to (1) utilize the more productive Rust programming language, (2) leverage a purpose-built toolkit called OSDK to streamline their workflows, and (3) choose between releasing their kernel modules as open source or keeping them proprietary, thanks to the flexibility offered by MPL.

While the journey towards a production-grade OS kernel can be challenging, we are steadfastly progressing towards our goal. Currently, Asterinas only supports x86-64 VMs. However, our aim for 2024 is to make Asterinas production-ready on x86-64 VMs.

Getting Started

Get yourself an x86-64 Linux machine with Docker installed. Follow the three simple steps below to get Asterinas up and running.

  1. Download the latest source code.
git clone https://github.com/asterinas/asterinas
  1. Run a Docker container as the development environment.
docker run -it --privileged --network=host --device=/dev/kvm -v $(pwd)/asterinas:/root/asterinas asterinas/asterinas:0.9.0
  1. Inside the container, go to the project folder to build and run Asterinas.
make build
make run

If everything goes well, Asterinas is now up and running inside a VM.

The Book

See The Asterinas Book to learn more about the project.

License

Asterinas's source code and documentation primarily use the Mozilla Public License (MPL), Version 2.0. Select components are under more permissive licenses, detailed here. For the rationales behind the choice of MPL, see here.