asterinas

Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.

Go to file

Fabing Li 64d7303b0e Bump version to 0.9.3		2024-10-16 10:28:54 +08:00
.github	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
.vscode	Fix all spelling mistakes in history by typos tool	2024-08-27 12:19:48 +08:00
docs	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
kernel	Fix minor bugs in TDX env	2024-10-14 21:03:47 +08:00
osdk	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
ostd	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
test	Add tcp latency test over virtio-net	2024-10-14 20:59:25 +08:00
tools	Resolve cargo publish --dry-run check failure	2024-10-16 10:10:08 +08:00
.code-workspace	…
.dockerignore	Rename regression to test	2024-06-28 20:33:21 +08:00
.gitignore	Add benchmark CI for sysbench and getpid	2024-06-26 20:58:12 +08:00
.licenserc.yaml	Remove local tdx-guest crate	2024-04-29 10:13:04 +08:00
.typos.toml	Fix the typo checker false positive `sie`	2024-09-30 11:17:34 +08:00
COPYRIGHT	…
Cargo.lock	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
Cargo.toml	Implement atomic wrapper for integer-like type	2024-09-25 14:47:37 +08:00
Components.toml	Remove the shim kernel crate	2024-08-23 23:37:50 +08:00
LICENSE-MPL	…
Makefile	Temporarily disable self-decompression	2024-10-16 10:05:34 +08:00
OSDK.toml	Remove unused field in OSDK config file	2024-10-04 10:08:03 +08:00
README.md	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
README_CN.md	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
VERSION	Bump version to 0.9.3	2024-10-16 10:28:54 +08:00
rust-toolchain.toml	Update the Rust toolchain to `nightly-2024-10-12`	2024-10-13 22:32:05 +08:00
rustfmt.toml	…
triagebot.toml	Add @boterinas (a triagebot) for Asterinas	2024-08-05 10:31:10 +08:00

README.md

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

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.

Download the latest source code.

git clone https://github.com/asterinas/asterinas

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.3

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.