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.
1,299 Commits 1 Branch 35 Tags 60 MiB
Rust 90.2%
C 6%
Shell 1.5%
Assembly 1%
Nix 0.6%
Other 0.7%
Go to file
Zhang Junyang d76c7a5b1e OSDK check and clippy with `cfg(ktest)` 2024-08-23 23:37:50 +08:00
.github Extract the OSTD test runner as a kernel 2024-08-23 23:37:50 +08:00
.vscode Adjust cargo check script in rust analyzer 2024-08-16 10:43:55 +08:00
docs Don't inherit OSDK manifest values from workspace root 2024-08-23 23:37:50 +08:00
kernel OSDK check and clippy with `cfg(ktest)` 2024-08-23 23:37:50 +08:00
osdk OSDK check and clippy with `cfg(ktest)` 2024-08-23 23:37:50 +08:00
ostd OSDK check and clippy with `cfg(ktest)` 2024-08-23 23:37:50 +08:00
test Add lmbench fifo latency test 2024-08-23 19:56:36 +08:00
tools Extract the OSTD test runner as a kernel 2024-08-23 23:37:50 +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
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Extract the OSTD test runner as a kernel 2024-08-23 23:37:50 +08:00
Cargo.toml Extract the OSTD test runner as a kernel 2024-08-23 23:37:50 +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 OSDK check and clippy with `cfg(ktest)` 2024-08-23 23:37:50 +08:00
OSDK.toml Fix a typo 2024-08-13 20:27:21 +08:00
README.md Modify Dockerfile and bump the version file 2024-08-22 09:55:19 +08:00
README_CN.md Modify Dockerfile and bump the version file 2024-08-22 09:55:19 +08:00
VERSION Modify Dockerfile and bump the version file 2024-08-22 09:55:19 +08:00
rust-toolchain.toml Update the Rust toolchain to 2024-06-20 2024-06-21 10:57:08 +08:00
rustfmt.toml Add rustfmt.toml configuration to adjust the format of imports 2024-02-26 10:03:45 +08:00
triagebot.toml Add @boterinas (a triagebot) for Asterinas 2024-08-05 10:31:10 +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.7.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.