Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Tate, Hongliang Tian b42d596ec4 Update README for 2025 2025-02-08 14:47:56 +08:00
.github Add nginx benchmark and workaround 2025-01-01 10:43:14 +08:00
.vscode Fix all spelling mistakes in history by typos tool 2024-08-27 12:19:48 +08:00
docs Add the doc of `cargo osdk profile` to the book 2025-01-21 09:59:03 +08:00
kernel Cache negative dentries for faster negative lookups 2025-01-24 11:48:15 +08:00
osdk Refactor boot modules to make heap allocation explicit 2025-01-02 10:41:51 +08:00
ostd Use `FnOnce() + Send` as task `func` 2025-01-23 09:57:10 +08:00
test Add INITRAMFS_SKIP_GZIP option to make initramfs encoding/decoding faster 2025-01-23 10:50:43 +08:00
tools Install apache web server in docker image 2024-12-30 16:24:22 +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 Adjust the lint check to recognize "wrk" as a valid word. 2024-12-31 10:38:24 +08:00
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Add mlsdisk as a component 2025-01-01 09:19:32 +08:00
Cargo.toml Add mlsdisk as a component 2025-01-01 09:19:32 +08:00
Components.toml Add mlsdisk as a component 2025-01-01 09:19:32 +08:00
LICENSE-MPL Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Makefile Add INITRAMFS_SKIP_GZIP option to make initramfs encoding/decoding faster 2025-01-23 10:50:43 +08:00
OSDK.toml Unify the qemu arguments generation 2024-11-05 19:39:05 +08:00
README.md Update README for 2025 2025-02-08 14:47:56 +08:00
README_CN.md Update README for 2025 2025-02-08 14:47:56 +08:00
README_JP.md Update README for 2025 2025-02-08 14:47:56 +08:00
VERSION Bump version to 0.11.1 2024-12-30 16:24:22 +08:00
rust-toolchain.toml Fix compile error caused by updated `Step::steps_between` in Rust 2024-12-01 18:56:28 +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.11.1
  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.