Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/theseus-os/Theseus

Theseus is a modern OS written from scratch in Rust that explores 𝐢𝐧𝐭𝐫𝐚𝐥𝐢𝐧𝐠𝐮𝐚𝐥 𝐝𝐞𝐬𝐢𝐠𝐧: closing the semantic gap between compiler and hardware by maximally leveraging the power of language safety and affine types. Theseus aims to shift OS responsibilities like resource management into the compiler.
https://github.com/theseus-os/Theseus

intralingual kernel operating-system research rust theseus

Last synced: about 2 months ago
JSON representation

Theseus is a modern OS written from scratch in Rust that explores 𝐢𝐧𝐭𝐫𝐚𝐥𝐢𝐧𝐠𝐮𝐚𝐥 𝐝𝐞𝐬𝐢𝐠𝐧: closing the semantic gap between compiler and hardware by maximally leveraging the power of language safety and affine types. Theseus aims to shift OS responsibilities like resource management into the compiler.

Lists

README 

        
# Theseus OS



[![Documentation](https://img.shields.io/badge/view-docs-blue)](https://theseus-os.github.io/Theseus/doc/___Theseus_Crates___/index.html)

[![Book](https://img.shields.io/badge/view-book-blueviolet)](https://theseus-os.github.io/Theseus/book/index.html)

[![Blog](https://img.shields.io/badge/view-blog-orange)](https://theseus-os.com)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=flat&logo=discord&logoColor=white)](https://discord.gg/NuUnqeYT8R)




[![Build Action](https://img.shields.io/github/actions/workflow/status/theseus-os/Theseus/docs.yaml?label=build)](https://github.com/theseus-os/Theseus/actions/workflows/docs.yaml)

[![Clippy Action](https://img.shields.io/github/actions/workflow/status/theseus-os/Theseus/check-clippy.yaml?label=clippy)](https://github.com/theseus-os/Theseus/actions/workflows/check-clippy.yaml)

[![QEMU tests](https://img.shields.io/github/actions/workflow/status/theseus-os/Theseus/test.yaml?label=QEMU%20tests)](https://github.com/theseus-os/Theseus/actions/workflows/test.yaml)



Theseus is a new OS written from scratch in [Rust](https://www.rust-lang.org/) to experiment with novel OS structure, better state management, and how to leverage **intralingual design** principles to shift OS responsibilities like resource management into the compiler.



For more info, check out Theseus's [documentation](#Documentation) or our [published academic papers](https://theseus-os.github.io/Theseus/book/misc/papers_presentations.html), which describe Theseus's design and implementation. 



Theseus is under active development, and although it is not yet mature, we envision that Theseus will be useful in high-end embedded systems or edge datacenter environments. 

We are continually working to improve the OS, including its fault recovery abilities for higher system availability without redundancy, as well as easier and more arbitrary live evolution and runtime flexibility.



# Quick start

On Linux (Debian-like distros), do the following:

 1. Obtain the Theseus repository (with all submodules):    

    ```

    git clone --recurse-submodules --depth 1 https://github.com/theseus-os/Theseus.git

    ```

 2. Install Rust:

    ```

    curl https://sh.rustup.rs -sSf | sh

    ```

 3. Install dependencies:

    ```

    sudo apt-get install make gcc nasm pkg-config grub-pc-bin mtools xorriso qemu qemu-kvm wget

    ```

 4. Build and run (in QEMU):

    ```sh

    cd Theseus

    make run

    ```

    To exit QEMU, press Ctrl + A, then X.



See below for more detailed instructions.



# Building and Running Theseus

**Note:** when you first check out the project, be sure to get all the submodule repositories too:

```

git submodule update --init --recursive

```



Currently, we support building Theseus on the following platforms:

 * Linux, 64-bit Debian-based distributions like Ubuntu, tested on Ubuntu 16.04, 18.04, 20.04. 

   - Arch Linux and Fedora have also been reported to work correctly. 

 * Windows, using the Windows Subsystem for Linux (WSL), tested on the Ubuntu version of WSL and WSL2.

 * MacOS, tested on versions High Sierra (v10.13), Catalina (v10.15), and Ventura (v13.5).

 * Docker, atop any host OS that can run a Docker container.



## Setting up the build environment



First, install Rust by following the [setup instructions here](https://www.rust-lang.org/en-US/install.html). On Linux, just run:

```sh

curl https://sh.rustup.rs -sSf | sh

```



### Building on Linux or WSL (Windows Subsystem for Linux)

Install the following dependencies using your package manager:

```bash

sudo apt-get install make gcc nasm pkg-config grub-pc-bin mtools xorriso qemu qemu-kvm wget

```



  * Or:

    ```bash

    # Arch Linux

    sudo pacman -S make gcc nasm pkg-config grub mtools xorriso qemu wget



    # Fedora

    sudo dnf install make gcc nasm pkg-config grub2 mtools xorriso qemu wget

    ```



If you're on WSL, also do the following steps:

  * Install an X Server for Windows; we suggest using [Xming](https://sourceforge.net/projects/xming/) or [VcXsvr](https://sourceforge.net/projects/vcxsrv/).

    * You'll likely need to invoke those X servers with the `-ac` argument (or use the GUI to disable access control). 

  * Setup an X display as follows:

    * on original WSL (version 1), run:

      ```sh

      export DISPLAY=:0

      ```

    * on WSL2 (version 2), run:

      ```sh

      export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0

      ```



    You'll need to do this each time you open up a new WSL terminal, so it's best to add it to the end of your `.bashrc` or `.profile` file in your `$HOME` directory.

  * If you get an error like `Could not initialize SDL (No available video device) ...` or any type of GTK or video device error, then make sure that your X Server is running and that you have set the `DISPLAY` environment variable above.

  * **NOTE**: WSL and WSL2 do not currently support using KVM.



### Building on MacOS

  * Install [HomeBrew](https://brew.sh/), then run the MacOS build setup script:

    ```sh

    sh ./scripts/mac_os_build_setup.sh

    ```

    If things go wrong, remove the following build directories and try to run the script again.

    ```sh

    rm -rf /tmp/theseus_tools_src

    ```

  * **NOTE**: on MacOS, you need to run `gmake` instead of `make` for build commands (or you can simply create a shell alias).

    * This is because HomeBrew installs its binaries in a way that doesn't conflict with built-in versions of system utilities.

  

  * *(This is typically not necessary)*: if you're building Theseus on older Apple Silicon (M1 chips), you may need to use `bash` with x86 emulation:

    ```sh

    arch -x86_64 bash   # or another shell of your choice

    ```

    and possibly adjust your system `PATH` if both x86 and ARM homebrew binaries are installed:

    ```sh

    export PATH=/usr/local/Homebrew/bin:$PATH

    ```



### Building using Docker

Note: building and running Theseus within a Docker container may be slower than on a native host OS.

 1. Ensure docker scripts are executable:

    ```

    chmod +x docker/*.sh

    ```   

 2. *(Skip if docker is already installed.)*  Install [Docker Engine](https://docs.docker.com/engine/install/). We provide a convenience script for this on Ubuntu:

    ```

    ./docker/install_docker_ubuntu.sh

    ``` 

    * After docker installs, enable your user account to run docker without root privileges:   

      `sudo groupadd docker; sudo usermod -aG docker $USER`    

      Then, **log out and log back in** (or restart your computer) for the user/group changes to take effect.

 

 3. Build the docker image:     

    ```

    ./docker/build_docker.sh

    ```    

    This does not build Theseus, but rather only creates a docker image that contains all the necessary dependencies to build and run Theseus. 

 4. Run the new docker image locally as a container:    

    ```

    ./docker/run_docker.sh

    ```   

    Now you can run `make run` or other Theseus-specific build/run commands from within the docker container's shell.



Notes on Docker usage:    

  * The docker-based workflow should only require you to re-run the `run_docker.sh` script multiple times when re-building or running Theseus after modifying its code. You shouldn't need to re-run `build_docker.sh` multiple times, though it won't hurt.

  * KVM doesn't currently work in docker. To run Theseus in QEMU using KVM, you can build Theseus within docker, exit the container (via Ctrl + D`), and then run `make orun host=yes` on your host machine.



## Building and Running

Build the default Theseus OS image and run it in QEMU:   

```sh

make run

```



Or, build a full Theseus OS image with all features and crates enabled:

```sh

make full   ## or `make all`

```



Run `make help` to see other make targets and the various command-line options.



## Using the Limine bootloader instead of GRUB

To use Limine instead of GRUB, clone pre-built limine and pass `bootloader=limine` to make:

```sh

git clone https://github.com/limine-bootloader/limine.git limine-prebuilt

git -C limine-prebuilt reset --hard 3f6a330

make run bootloader=limine

```

Feel free to try newer versions, however they may not work.



## Targeting ARMv8 (aarch64)

Support for Theseus on aarch64 is an ongoing effort, but most of the core subsystems are complete.



To build and run Theseus on aarch64, first install the required dependencies:

* On Debian-like Linux (Ubuntu, etc):

  ```bash

  sudo apt-get install qemu-system-arm gcc-aarch64-linux-gnu

  ```

* On Arch Linux:

  ```bash

  sudo pacman -S aarch64-linux-gnu-gcc qemu-system-aarch64

  ```

* On macOS, the `mac_os_build_setup` script should have already installed this for you, but if not:

  ```zsh

  brew install aarch64-elf-gcc aarch64-elf-binutils



  ```



Then, build Theseus and run it in QEMU:

```bash

make ARCH=aarch64 run

```



Doing a "full" build of all Theseus crates isn't yet supported on aarch64,

as our aarch64 support in Theseus doesn't yet cover *all* crates in the entire repo.



## Using QEMU

QEMU allows us to run Theseus quickly and easily in its own virtual machine.

To release your keyboard and mouse focus from the QEMU window, press Ctrl + Alt + G, or Ctrl + Alt on some systems, or just Cmd + Tab out to another app on macOS.

To exit QEMU, in the terminal window that you originally ran `make run`, press Ctrl + A then X, or you can also click the GUI `ⓧ` button on the title bar if running QEMU in graphical mode.



To investigate the hardware/machine state of the running QEMU VM, you can switch to the QEMU console by pressing Ctrl + Alt + 2.

Switch back to the main window with Ctrl + Alt + 1.

On Mac, manually select `VGA` or `compact_monitor0` under `View` from the QEMU menu bar.



To access/expose a PCI device in QEMU using PCI passthrough via VFIO, see [these instructions](https://theseus-os.github.io/Theseus/book/running/virtual_machine/pci_passthrough.html).



Linux does not support the ICMP protocol (for `ping`) for guest OSes in QEMU by default, so to allow `ping` to work on Theseus, you may need to run the following in your Linux host machine:

```sh

sudo sh -c "echo \"0 2147483647\" > /proc/sys/net/ipv4/ping_group_range"

```



### KVM Support

While not strictly required, KVM will speed up the execution of QEMU.

To install KVM, run the following command:    

```sh

sudo apt-get install kvm

```  

To enable KVM support, add `host=yes` to your make command, e.g.,    

```

make run host=yes

```



Note that KVM acceleration is only supported on native Linux hosts.



# Documentation

Theseus includes two forms of documentation:

1. The [source-level documentation](https://theseus-os.github.io/Theseus/doc/___Theseus_Crates___/index.html), generated from code and inline comments (via *rustdoc*).

    * Intended for Theseus developers and contributors, or those who want low-level details.

2. The [book-style documentation](https://theseus-os.github.io/Theseus/book/index.html), written in Markdown.

    * Useful for high-level descriptions of design concepts and key components.



To build the documentation yourself, set up your local build environment and then run the following:

```sh

make view-doc   ## for the source-level docs

make view-book  ## for the Theseus book

```



# Other



## Booting on Real Hardware

We have tested Theseus on a variety of real machines, including Intel NUC devices, various Thinkpad laptops, and Supermicro servers. 

Currently, we have only tested booting Theseus via USB or PXE using a traditional BIOS bootloader rather than UEFI, but UEFI is fully supported so it should work.



To boot over USB, simply run `make usb drive=sdc`, in which `sdc` is the device node for the USB disk itself *(**not a partition** like sdc2)* to which you want to write the OS image.

On WSL or other host environments where `/dev` device nodes don't exist, you can simply run `make iso` and burn the `.iso` file in the `build/` directory to a USB, e.g., using [Rufus](https://rufus.ie/) on Windows.



To boot Theseus over PXE (network boot), see [this set of separate instructions](https://theseus-os.github.io/Theseus/book/running/pxe.html).



## Debugging Theseus on QEMU

GDB has built-in support for QEMU, but it doesn't play nicely with OSes that run in 64-bit long mode. In order to get it working properly with our OS in Rust, we need to patch it and build it locally. The hard part has already been done for us ([details here](https://os.phil-opp.com/set-up-gdb/)), so we can just quickly set it up with the following commands.  



1. Install the following packages:

    ```

    sudo apt-get install texinfo flex bison python-dev ncurses-dev

    ```



2. From the base Theseus directory, run this script to download and build GDB from an existing patched repo:

    ```

    curl -sf https://raw.githubusercontent.com/phil-opp/binutils-gdb/rust-os/build-rust-os-gdb.sh | sh

    ```

    After that, you should have a `rust-os-gdb` directory that contains the `gdb` executables and scripts. 



3. Run Theseus in QEMU using `make run` (or `make run_pause` to pause QEMU until we attach GDB).



4. In another terminal window, run the following to start GDB and attach it to the running QEMU instance:

    ```

    make gdb 

    ```

    QEMU will be paused until we move the debugger forward, with standard GDB commands like `n` to step through the next instruction or `c` to continue execution. Any standard GDB commands will now work.



### Connecting GDB to aarch64 Theseus on QEMU

We don't yet have a patched version of GDB for aarch64 targets, but we can use the existing `gdb-multiarch` package to 



1. Install the required package:

    ```sh

    sudo apt-get install gdb-multiarch

    ```



2. Build Theseus for aarch64 and run it in QEMU:

    ```sh

    make ARCH=aarch64 run ## or use `run_pause`

    ```

3. In another terminal window, run the following to start GDB and attach it to the running QEMU instance:

    ```sh

    gdb-multiarch -ex "target remote :1234"

    ```



4. Within GDB, symbols aren't yet supported, but you can view assembly code with `layout asm` and set breakpoints on virtual addresses.



## IDE Setup  

Our personal preference is to use VS Code, which has excellent cross-platform support for Rust. Other options are available [here](https://areweideyet.com/).



For VS Code, recommended plugins are:

 * **rust-analyzer**, by matklad

 * **Better TOML**, by bungcip

 * **x86 and x86_64 Assembly**, by 13xforever

 



## Acknowledgements

We would like to express our thanks to the [OS Dev wiki](https://wiki.osdev.org/) and its community and to Philipp Oppermann's [blog_os](https://os.phil-opp.com/) for serving as excellent starting points for Theseus. The early days of Theseus's development progress are indebted to these resources. 



## License

Theseus's source code is licensed under the MIT License. See the [LICENSE-MIT](LICENSE-MIT) file for more. 



## Contributing

We adhere to similar development and code style guidelines as the core Rust language project. See more [here](https://theseus-os.github.io/Theseus/book/contribute/contribute.html).



PRs and issues are welcome from anyone; because Theseus is an experimental OS, certain features may be deprioritized or excluded from the main branch. Don't hesitate to ask or mention something though! :smile: