Accelerate OS development with Asterinas OSDK

What is it?

OSDK (short for Operating System Development Kit) is designed to simplify the development of Rust operating systems. It aims to streamline the process by leveraging the framekernel architecture, originally proposed by Asterinas.

cargo-osdk is a command-line tool that facilitates project management for those developed on the framekernel architecture. Much like Cargo for Rust projects, cargo-osdk enables building, running, and testing projects conveniently.

Install the tool

Requirements

Currently, cargo-osdk only supports x86_64 ubuntu system.

To run a kernel with QEMU, cargo-osdk requires the following tools to be installed:

• Rust >= 1.75.0
• cargo-binutils
• gcc
• qemu-system-x86_64
• grub-mkrescue
• ovmf
• xorriso

About how to install Rust, you can refer to the official site.

After installing Rust, you can install Cargo tools by

cargo install cargo-binutils

Other tools can be installed by

apt install build-essential grub2-common qemu-system-x86 ovmf xorriso

Install

Then, cargo-osdk can be installed by

cargo install cargo-osdk

Upgrade

If cargo-osdk is already installed, the tool can be upgraded by

cargo install --force cargo-osdk

Getting started

Here we provide a simple demo to demonstrate how to create and run a simple kernel with cargo-osdk.

With cargo-osdk, a kernel project can be created by one command

cargo osdk new --kernel my-first-os

Then, you can run the kernel with

cd my-first-os && cargo osdk run

You will see Hello world from guest kernel! from your console.

Basic usage

The basic usage of cargo-osdk is

cargo osdk <COMMAND>

Currently we support following commands:

• new: Create a new kernel package or library package
• build: Compile the project and its dependencies
• run: Run the kernel with a VMM
• debug: Debug a remote target via GDB
• test: Execute kernel mode unit test by starting a VMM
• check: Analyze the current package and report errors
• clippy: Check the current package and catch common mistakes
• doc: Build Rust documentations

The following command can be used to discover the available options for each command.

cargo osdk help <COMMAND>

The OSDK manifest

cargo-osdk utilizes a configuration file named OSDK.toml to define its precise behavior. To learn more about the manifest specification, please refer to the book.

Contributing

Asterinas OSDK is developed as a sub-project of Asterinas. It shares the same repository and versioning rules with the kernel. Please contribute to OSDK according to the contribution guide of Asterinas.

Note for Visual Studio Code users

To enable advanced features of the editor on OSDK, please open the Asterinas repository as a workspace using the File > Open Workspace from File... menu entry, and select the file .code-workspace in the Asterinas repository root as the configuration.