RustOS Documentation
English
RustOS is a Rust-built hybrid microkernel with native binary
compatibility for Linux ELF and Windows PE programs. The kernel keeps only
the mechanisms that require ring0 — trap entry, paging, scheduling,
IRQ/MMIO/DMA bridges, and a small set of gated brokers — and pushes
everything else into userspace services. A built-in Wayland compositor in
uiserver provides the desktop surface for both native and PE clients.
This book is split by audience:
- Start: build, run, debug, and follow the OS execution flow.
- Architecture: how the microkernel and services fit together, the Wayland UI server, the compat path, and repo structure/logging rules.
- OS Developer APIs: kernel crate APIs,
cargo xtask, theRUSTOS.package.tomlmanifest, and runtime control. - Guides: end-to-end recipes for adding services, apps, and drivers.
- Reference: stable paths and environment variables.
- AI Agent Reference: compact machine-oriented context under
docs/ai/.
Recommended reading order:
- Getting Started
- Execution Flow
- Microkernel Overview
- Userspace Services
- Userspace Compatibility
- UI Server & Wayland
- Structure Guide
- Kernel API
- xtask API
- Package Manifest API
- Logging Guide
- Fault Injection
한국어
RustOS는 Rust로 작성된 hybrid microkernel이며, Linux ELF와 Windows PE
실행 파일에 대해 native binary compatibility를 목표로 합니다. 커널은
ring0가 반드시 필요한 mechanism — trap entry, paging, scheduling,
IRQ/MMIO/DMA bridge, 그리고 소수의 gated broker — 만 남기고 나머지는
모두 userspace service로 옮깁니다. uiserver에 내장된 Wayland compositor
가 native client와 PE client 모두에게 desktop surface를 제공합니다.
이 문서는 대상별로 나뉩니다.
- Start: build, run, debug, 그리고 OS 실행 흐름.
- Architecture: microkernel과 service들이 어떻게 맞물리는지, Wayland UI server, 호환 경로, repo 구조와 logging 규칙.
- OS Developer APIs: kernel crate API,
cargo xtask,RUSTOS.package.tomlmanifest, runtime control. - Guides: service / app / driver를 추가하는 끝-끝 절차.
- Reference: 안정적인 path와 environment variable.
- AI Agent Reference:
docs/ai/아래의 짧은 machine-oriented context.
추천 읽기 순서: