How d3ara1n/halcyon works
Project Type and Purpose
• This is an educational, monolithic RV64 operating system (“eRhino”) written in Rust.
• It comprises:
• A boot‐time submodule layer (OpenSBI, U‑Boot, DTB parser)
• A kernel (“os/kernel”) with subsystems (MM, FS, IPC, scheduler, drivers, SBI interface)
• A shared Rust crate (“shared/”) used by both kernel and user space
• A user space stack (“user/”) including drivers, frameworks, a minimal runtime library (rinlib), and system binaries (fs, init, pm)
• Support for multiple platforms (QEMU virt, sifive_u, Kendryte K210, Renode)
File Structure Analysis
• Top‐level directories:
• os/: Kernel code + platform definitions (linker scripts, DTS)
• shared/: Common abstractions (calls, FAL, IPC, sync, time, etc.)
• user/:
– drivers/ (e.g., SPI)
– frameworks/ (libdrv, libfal, libsrv)
– rinlib/ (runtime support: threads, IPC, FS, RT)
– systems/ (userland binaries: fs, init, pm)
• submodules/: External repos (dtb_parser, opensbi, u‑boot)
• Kernel follows a layered, modular design: board abstraction → device drivers → core subsystems (MM, FS, task, IPC, timer, console) → SBI as lowest‐level interface
README Insights
• The README confirms:
• Design notes under notes/*.md (e.g., IPC, FS architecture)
• Build & run flows using Justfile with PLATFORM/MODEL variables
• Current progress (IPC, FS, supported platforms)
• Userland relies on rinlib in lieu of std