Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Fabing Li 9872adaa71 Fix release_tag 2025-03-25 09:11:24 +08:00
.github Fix release_tag 2025-03-25 09:11:24 +08:00
.vscode Fix all spelling mistakes in history by typos tool 2024-08-27 12:19:48 +08:00
docs Update docker version refs to 0.14.1 2025-03-22 15:55:31 +08:00
kernel Change IoMem directory 2025-03-22 17:38:30 +08:00
osdk Correct OSDK profiling tool's behavior 2025-03-23 22:40:45 +08:00
ostd Simplify the lock usages when flush TLBs 2025-03-24 15:30:22 +08:00
test Add sys_signalfd/sys_signalfd implementation 2025-03-21 16:10:55 +08:00
tools Fix release_tag 2025-03-25 09:11:24 +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 Let git ignore profile results 2025-02-13 16:01:40 +08:00
.licenserc.yaml Remove local tdx-guest crate 2024-04-29 10:13:04 +08:00
.typos.toml Add the word typ to the typos checking whitelist 2025-03-03 15:16:42 +08:00
CODEOWNERS Add the CODEOWNERS file 2025-03-21 12:52:53 +08:00
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Bump the version to 0.14.1 2025-03-22 15:55:31 +08:00
Cargo.toml `force-unwind-tables=yes` instead of `panic=unwind` 2025-03-20 11:44:28 +08:00
Components.toml Add mlsdisk as a component 2025-01-01 09:19:32 +08:00
DOCKER_IMAGE_VERSION Bump docker version to 0.14.1 2025-03-22 10:59:57 +08:00
LICENSE-MPL Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Makefile Adjust feature selection 2025-03-20 11:44:28 +08:00
OSDK.toml Unify the qemu arguments generation 2024-11-05 19:39:05 +08:00
README.md Update docker version refs to 0.14.1 2025-03-22 15:55:31 +08:00
README_CN.md Update docker version refs to 0.14.1 2025-03-22 15:55:31 +08:00
README_JP.md Update docker version refs to 0.14.1 2025-03-22 15:55:31 +08:00
VERSION Bump the version to 0.14.1 2025-03-22 15:55:31 +08:00
rust-toolchain.toml Upgrade the toolchain to nightly-2025-02-01 2025-02-27 09:05:03 +08:00
rustfmt.toml Add rustfmt.toml configuration to adjust the format of imports 2024-02-26 10:03:45 +08:00
triagebot.toml Manage S-waiting-on-author and S-waiting-on-review automatically 2024-10-24 19:12:04 +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 is challenging, we are steadfastly progressing towards this goal. Over the course of 2024, we significantly enhanced Asterinas's maturity, as detailed in our end-year report. In 2025, our primary goal is to make Asterinas production-ready on x86-64 virtual machines and attract real users!

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.14.1-20250322
  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.