Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Zhang Junyang ef6ff7ad84 Let frame on-drop call backs take readers 2024-12-27 12:12:51 +08:00
.github Bump the version to 0.11.0 2024-12-26 19:20:58 +08:00
.vscode
docs Bump the version to 0.11.0 2024-12-26 19:20:58 +08:00
kernel Renaming concepts around pages and frames 2024-12-27 12:12:51 +08:00
osdk Renaming concepts around pages and frames 2024-12-27 12:12:51 +08:00
ostd Let frame on-drop call backs take readers 2024-12-27 12:12:51 +08:00
test Add support for group-based permission checking in ext2 2024-12-26 17:07:55 +08:00
tools Fix bug for memcached install 2024-12-27 07:55:28 +08:00
.code-workspace
.dockerignore
.gitignore
.licenserc.yaml
.typos.toml Add ext2 benchmarks of sqlite 2024-12-11 23:04:49 +08:00
COPYRIGHT
Cargo.lock Bump the version to 0.11.0 2024-12-26 19:20:58 +08:00
Cargo.toml Enhance OSDK performance by reusing existing base, bundle and build 2024-12-15 16:42:57 +08:00
Components.toml Inject the logger for Asterinas 2024-12-04 13:24:06 +08:00
LICENSE-MPL
Makefile Enhance OSDK performance by reusing existing base, bundle and build 2024-12-15 16:42:57 +08:00
OSDK.toml Unify the qemu arguments generation 2024-11-05 19:39:05 +08:00
README.md Bump the version to 0.11.0 2024-12-26 19:20:58 +08:00
README_CN.md Bump the version to 0.11.0 2024-12-26 19:20:58 +08:00
README_JP.md docs: add Japanese README 2024-10-27 09:54:24 +08:00
VERSION Bump the version to 0.11.0 2024-12-26 19:20:58 +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
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 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.11.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 rationales behind the choice of MPL, see here.