w568w / Rarmo

Rarmo (stands for `Rarmo - A Rust Made OS` or `Rust ARM OS`). Just for learning purposes.

Rarmo

A simple operating system in Rust.

Rarmo stands for Rusty ARM Operating system or Rarmo is A Rust-Made Operating system.

It is a simple operating system written in Rust for aarch64, and a hobby project to learn more about operating systems and its concepts.

At this moment, it does not have a GUI or even a simple shell, but it can boot on Raspberry PI 3 / 3B, use standard I/O with GPIO interface and run some simple codes in Rust.

How to build

(Note: for TA of this course, please refer to this guide for a quick run.)

Prerequisites

First of all, you need to install some tools to build Rarmo.

You can find the list of tools in Makefile.

Rarmo should be able to be built on Linux, macOS and Windows with MSYS2.

Build

1. Clone this repository with git clone https://github.com/w568w/Rarmo.git;
2. Modify the Makefile to fit your environment;
3. Run make all to build Rarmo; here are some useful targets:
   • make all: build Rarmo;
   • make test: run unit tests;
   • make run: build Rarmo and run it in QEMU;
   • make clean: clean the build;
   • make qemu-debug: build Rarmo and run QEMU in debug mode (no display, but you can use GDB to debug);
   • make debug: build Rarmo and start a connected GDB for debugging;

Notes 1:

If you are using MSYS2, you need to run make tool with mingw32-make.exe or mingw64-make.exe under MSYS2 MinGW 32-bit or MSYS2 MinGW 64-bit respectively.

Notes 2:

If you are using Windows, you need to install aarch64-gcc, QEMU and GDB by yourself.

Prevent using special characters in the path of Rarmo, QEMU and GDB (e.g. spaces, Chinese characters, etc.), or you may encounter some problems.

If you have done so, use a more modern and Windows-friendly shell, such as Powershell, to build Rarmo. Do not stick to the old cmd or Linux-prone bash.

References

Some codes come from the following projects / articles / labs:

• Writing an OS in Rust
• rCore-Tutorial-Book-v3
• Fudan OS2021 Fall, lab1
• Fudan OS2022 Fall

Acknowledgements

I would like to thank the authors of the above ones for their great work.

Also, Huawei's Intelligent Center Plan with Fudan University provided a great opportunity to learn more about Kunpeng processors and operating systems.

License

Rarmo is licensed under the MIT License.