qiurui
/
asterinas
mirror of https://github.com/asterinas/asterinas.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
649 Commits 1 Branch 32 Tags 42 MiB
Rust 90.9%
C 5.6%
Shell 1.5%
Assembly 1.1%
Makefile 0.5%
Other 0.4%
Go to file
Ruihan Li 60cd65d837 Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
.github/workflows Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
.vscode Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
docs Refine osdk doc 2024-03-13 11:26:59 +08:00
framework Fix all doc warnings 2024-03-17 19:12:33 +08:00
kernel Fix all doc warnings 2024-03-17 19:12:33 +08:00
osdk Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
regression Fix dependencies of initramfs 2024-03-15 12:52:56 +08:00
tools Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
.dockerignore
…
.gitignore Remove outdated gitignore entries 2024-03-15 12:52:56 +08:00
.licenserc.yaml Refactor project structure 2024-02-28 16:30:48 +08:00
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Replace `Poisoned` state by `takeable` crate 2024-03-14 21:22:44 +08:00
Cargo.toml Fix workspace clippy usage 2024-02-28 16:30:48 +08:00
Components.toml Rename aster-std to aster-nix 2024-02-06 10:43:40 +08:00
LICENSE-MPL Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Makefile Make OSDK wrapped commands unified and fix make docs 2024-03-17 19:12:33 +08:00
OSDK.toml Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
README.md Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
README_CN.md Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
VERSION Install `clang-format` in the Docker container 2024-03-18 11:20:46 +08:00
rust-toolchain.toml Update dev image for OSDK and bump version to 0.4.0 2024-02-28 16:30:48 +08:00
rustfmt.toml Add rustfmt.toml configuration to adjust the format of imports 2024-02-26 10:03:45 +08:00

README.md

asterinas-logo
A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux
OSDK Test Kernel Test

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