Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Yuke Peng 550eafcb79 Preallocate some space when expanding size in ramfs 2024-09-21 20:22:39 +08:00
.github Set fail-fast to false to avoid cancelling normal steps 2024-09-20 14:40:11 +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.8.3 2024-09-18 20:10:08 +08:00
kernel Preallocate some space when expanding size in ramfs 2024-09-21 20:22:39 +08:00
osdk Bump the OSDK's Cargo.lock when bumping the versions 2024-09-21 15:19:35 +08:00
ostd Clean up the frame buffer state in `ostd::mm` 2024-09-21 15:38:15 +08:00
test Block failed futex and fcntl tests 2024-09-21 15:18:56 +08:00
tools Bump the OSDK's Cargo.lock when bumping the versions 2024-09-21 15:19:35 +08:00
.code-workspace Enable the rust-analyzer for OSDK 2024-04-25 09:44:46 +08:00
.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 all spelling mistakes in history by typos tool 2024-08-27 12:19:48 +08:00
COPYRIGHT
Cargo.lock Implement cpu_local with GS and ensure GS points to TSS 2024-09-19 13:00:36 +08:00
Cargo.toml Move smoltcp-related code to bigtcp 2024-09-13 21:31:20 +08:00
Components.toml Remove the shim kernel crate 2024-08-23 23:37:50 +08:00
LICENSE-MPL
Makefile Move smoltcp-related code to bigtcp 2024-09-13 21:31:20 +08:00
OSDK.toml Fix a typo 2024-08-13 20:27:21 +08:00
README.md Bump version to 0.8.3 2024-09-18 20:10:08 +08:00
README_CN.md Bump version to 0.8.3 2024-09-18 20:10:08 +08:00
VERSION Bump version to 0.8.3 2024-09-18 20:10:08 +08:00
rust-toolchain.toml Update the Rust toolchain to 2024-06-20 2024-06-21 10:57:08 +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
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.8.3
  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.