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.
610 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
Zhang Junyang eb42383532 Update READMEs for OSDK change 2024-02-28 16:30:48 +08:00
.github/workflows Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
.vscode Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
docs Add the Chinese version README 2024-02-15 16:52:25 +08:00
framework Apply the new format policy 2024-02-28 16:30:48 +08:00
osdk Apply the new format policy 2024-02-28 16:30:48 +08:00
regression Add support for chown syscall 2024-02-22 12:11:21 +08:00
services Apply the new format policy 2024-02-28 16:30:48 +08:00
src Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
tools Apply the new format policy 2024-02-28 16:30:48 +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 Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
Cargo.toml Implement OSDK functionalities and opt-in OSDK for asterinas 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 Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
OSDK.toml Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
README.md Update READMEs for OSDK change 2024-02-28 16:30:48 +08:00
README_CN.md Update READMEs for OSDK change 2024-02-28 16:30:48 +08:00
VERSION Add tools for exfat filesystem in docker image and bump the version 2024-02-27 18:28:13 +08:00
rust-toolchain.toml Implement OSDK functionalities and opt-in OSDK for asterinas 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

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 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.1
  1. Install the Asterinas OSDK from source.
make install_osdk
  1. Inside the container, go to the project folder to build and run Asterinas.
cargo osdk build
cargo osdk 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.