Skip to content


Switch branches/tags


CircleCI License: MIT


A toy operating system which supports NVDIMM natively.



Install Rust toolchain

Check the installation (below is an example output):

$ cargo --version
cargo 1.46.0 (149022b1d 2020-07-17)

Then, install nightly toolchain and cargo-xbuild for cross compiling.

rustup toolchain install nightly-x86_64-unknown-linux-gnu
rustup component add rust-src


brew install wget cmake qemu llvm dosfstools

Ubuntu 20.04

sudo apt install wget cmake qemu-system-x86 clang-8 lld-8 libc++-8-dev libc++abi-8-dev clang-format

Prepare tools and libraries

Move to the root of this source tree. Then:

make tools
make prebuilt

How to build


Run on QEMU

This repository contains OVMF binary for UEFI emulation.

make run

You can connect serial console using telnet

telnet localhost 1235

Run flags

Flags can be specified for make run command. Please check for more details.


make run GUI=n GDB=nosuspend
  • GUI
    • =y: Enable GUI
    • =n: Disable GUI (enable VNC server)
  • GDB
    • =n: Disable gdb server in QEMU
    • =suspend_on_boot: Enable gdb server and wait for a connection on startup
    • =nosuspend: Enable gdb server and startup the machine normally without waiting for a gdb connection

Setup tap interface (for linux)

make run boots liumOS on QEMU with a tap interface on Linux host. To avoid running QEMU with sudo, you need to setup a tap interface in advance.

sudo ip tuntap add dev tap0 mode tap user $USER
sudo ip link set dev tap0 master br0
sudo ip link set dev tap0 up

example output with bridge br0 connected to eno1

$ ip a | grep -e br0 -e tap0
2: eno1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq master br0 state UP group default qlen 1000
4: br0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
    inet brd scope global dynamic br0
6: tap0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel master br0 state UP group default qlen 1000

Setup bridge interface

global, persistent

      dhcp4: false
      dhcp6: false
      interfaces: [ eno1 ]
      dhcp4: true
  version: 2

How to contribute

Contributions are welcome! Please create a pull request to this repository.

Before submitting a PR, please check the test results with make test.

make commit does all the presubmit checks and creates a commit automatically (recommended!)

If you found any problems or questions, please let us know through Issues on GitHub.