Skip to content

hyperion-os/hyperion

Repository files navigation

Hyperion

A unix-like operating system written in pure Rust.

The kernel is monolithic at the moment, but I am currently converting it into a microkernel in the microkernel branch.

The operating system boots into a kernel mode shell (that will be gone in the future) where you can launch userland software like hysh, wm or doom if you also compiled those. The only external program that doesnt require my fork of the Rust compiler is doom. There are some ELFs that are automatically embedded into the kernel like ls, cat, fbtest and a bunch of other.

How do I run it?

Dependencies

Packages for Arch:

pacman -Syu make qemu-system-x86 xorriso jq

Rust:

# rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# bare metal target
rustup target add x86_64-unknown-none
# nightly compiler
rustup toolchain install nightly

In QEMU

It is as simple as just:

# normal
cargo run
# to see the launch options, run
cargo run -- --help

On HW?

Please don't

Compiling Rust programs for hyperion (with the std library)

Building x86_64-unknown-hyperion toolchain

# clone my rust fork
git clone git@github.com:xor-bits/rust.git
cd rust

# fix the hyperion-syscall path in library/std/Cargo.toml
# if both `rust` and `hyperion` are not in the same parent directory

# configure ./x for building the hyperion cross-compile target
# copy the config.toml base from 'shell.nix' (after `config = pkgs.writeText "rustc-config"`)
# or just use nix-shell

# compile the Rust compiler + std library + some tools for hyperion
# (`src/tools/rustfmt` and `proc-macro-srv-cli` are not needed but they are nice for me)
./x build src/tools/rustfmt proc-macro-srv-cli library compiler

# link the toolchain, so that the installed rustc can use it
rustup toolchain link dev-x86_64-unknown-hyperion build/host/stage1

Compiling with x86_64-unknown-hyperion

# remove the target dir, if the std library has been recompiled
# (rust doesn't detect that automatically for some reason)
rm -rf ./target/x86_64-unknown-hyperion
# I prefer keeping all build artefacts in one location to speed up compilation and reduce disk use:
#rm -rf $CARGO_HOME/target/x86_64-unknown-hyperion

# compile the package using x86_64-unknown-hyperion
cargo +dev-x86_64-unknown-hyperion build --target=x86_64-unknown-hyperion --bin=std-test
# or if you prefer:
rustup override set dev-x86_64-unknown-hyperion
# and now simply:
cargo build --target=x86_64-unknown-hyperion --package=std-test

# copy the binary to the asset directory (building the kernel will automatically embed it)
cp ./target/x86_64-unknown-hyperion/debug/std-test asset/bin/std-test
#cp $CARGO_HOME/target/x86_64-unknown-hyperion/debug/std-test asset/bin/std-test

Demo(s)

The first kernel side shell: image

The second kernel side shell: image

The current kernel side shell: image

A work in progress window manager + user space shell: image

Related repos:

  • rust: x86_64-unknown-hyperion Rust toolchain

  • hyperion-doom: Doom ported to hyperion

Font

The font used contains the first 256 bitmap glyphs from GNU Unifont