Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
LI Qing 8d456ebe8f Refine the build process with VDSO 2024-02-05 12:47:00 +08:00
.cargo Rename jinux-runner to aster-runner 2023-12-26 11:49:24 +08:00
.github/workflows Delete mergeable.yml 2024-01-26 13:28:18 +08:00
.vscode Extend Require macro to support impl block 2023-05-09 10:44:11 +08:00
docs Add an Overview of the Framework page 2024-01-28 20:33:22 +08:00
framework Replace `VmFrame::zero` with `VmWriter::fill` 2024-02-02 16:59:34 +08:00
kernel License rust and c source files 2024-01-18 08:22:58 +08:00
regression Refine the build process with VDSO 2024-02-05 12:47:00 +08:00
runner License rust and c source files 2024-01-18 08:22:58 +08:00
services Optimize the queries for intersected intervals in Vmar from O(n) to O(log(n)) 2024-02-03 17:00:49 +08:00
tools License Makefile, shell scripts, assembly source code, Dockerfile 2024-01-18 08:22:58 +08:00
.dockerignore Add version bumping mechanism 2023-08-14 10:45:01 +08:00
.gitignore Fix typos and add utils 2023-05-31 11:50:50 +08:00
.licenserc.yaml Add license check github action in ci 2024-01-18 08:22:58 +08:00
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Use asterinas inventory 2024-01-19 15:39:14 +08:00
Cargo.toml Rename boot-wrapper to bzimage-setup 2024-01-02 07:21:36 +08:00
Components.toml Raname kernel as asterinas 2023-12-26 11:49:24 +08:00
LICENSE-MPL Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Makefile Disambiguate runner args from krun args in Makefile 2024-01-30 20:15:53 +08:00
README.md Update README.md 2024-01-26 20:20:15 +08:00
VERSION Bump version to 0.3.0 2024-01-02 07:21:36 +08:00
build.rs License rust and c source files 2024-01-18 08:22:58 +08:00
rust-toolchain.toml Do mapping in the wrapper 2024-01-02 07:21:36 +08:00
x86_64-custom.json Implement should_panic for ktest and clear the codebase 2023-11-09 13:22:34 +08:00

README.md

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

Introducing Asterinas

Asterinas (星绽 in Chinese) is a safe, 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 for both bare-metal and VM environments.

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 ./asterinas:/root/asterinas asterinas/asterinas:0.3.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 rationles behind the choice of MPL, see here.