Data

Tools

Indexes

Applications

Experiments

Open Source Science

eduos-rs

A teaching operating system written in Rust

https://github.com/rwth-os/eduos-rs

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • ✓
    Institutional organization owner
    Organization rwth-os has institutional domain (www.os.rwth-aachen.de)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

eduos-rs kernel operating-system rust

Keywords from Contributors

unikernel hermit hypervisor kvm cloud-computing operating-systems osdev virtualization interactive network-simulation
Last synced: 4 months ago · JSON representation ·

Repository

A teaching operating system written in Rust

Basic Info
Statistics
  • Stars: 454
  • Watchers: 13
  • Forks: 27
  • Open Issues: 5
  • Releases: 37
Topics
eduos-rs kernel operating-system rust
Created almost 9 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

Actions Status

eduOS-rs - A teaching operating system written in Rust

Introduction

eduOS-rs is a Unix-like operating system based on a monolithic architecture for educational purposes. It is developed for the course Operating Systems at RWTH Aachen University. eduOS-rs is derived from following tutorials and software distributions:

  1. Philipp Oppermann's excellent series of blog posts.
  2. Erik Kidd's toyos-rs, which is an extension of Philipp Opermann's kernel.
  3. The original version of eduOS, which was the old teaching kernel written in C.
  4. eduOS-rs' uses a memory allocator, which is derived from the buddysystemallocator.
  5. The first version of paging is derived from a version, which was developed by Colin Finck.

Requirements to build eduOS-rs

eduOS-rs is tested under Linux, macOS, and Windows.

macOS

Apple's Command Line Tools must be installed. The Command Line Tool package gives macOS terminal users many commonly used tools and compilers, that are usually found in default Linux installations. Following terminal command installs these tools without Apple's IDE Xcode:

sh $ xcode-select --install

In addition, Qemu must be installed. Please use Homebrew as package manager to install Qemu.

sh $ brew install qemu

Windows

To build eduOS-rs you have to install Qemu and a git client. Please use Chocolatey as package manager to install Qemu and git.

sh $ choco install qemu git

Linux

Linux users should install common developer tools. For instance, on Ubuntu 22.04 the following command installs the required tools:

sh $ apt-get install -y git qemu-system-x86 build-essential

Common for macOS, Windows and Linux

This project uses Rustup to set its Rust toolchain. Follow the instructions to install Rust using Rustup.

In addition, the tool bootimage is required, which creates a bootable diskimage. Please install the tool with following command.

sh $ cargo install bootimage

Building

eduOS-rs is able to run within Qemu, which is a generic and open source machine emulator and virtualizer.

After cloning the repository, you can run the kernel with following command:

sh $ cargo run

Overview of all branches

Step by step (here branch by branch) the operating system design will be introduced. This tutorial shows the steps to develop from a minimal kernel to a Unix-like computer operating system. Currently, following stages of development are available:

  1. stage0 - Smallest HelloWorld of the World

Description of loading a minimal 64bit kernel

  1. stage1 - Cooperative/non-preemptive multitasking

Introduction into a simple form of multitasking, where no interrupts are required.

  1. stage2 - Priority-based cooperative/non-preemptive multitasking

Introduction into a simple form of priority-based multitasking, where no interrupts are required.

  1. stage3 - Synchronization primitives

Introduce basic synchronization primitives

  1. stage 4 - Preemptive multitasking

Introduction into preemptive multitasking and interrupt handling

  1. stage 5 - Support of user-level tasks

Add support of user-level tasks with an small interface for basic system calls

  1. stage 6 - Support of paging

Add support of paging and a simple demo for process creation

  1. stage 7 - Basic IO interface

Add basic support of file descriptors

  1. stage 8 - Integration of an in-memory file system

Introduce a virtual file system with an in-memory file system as example file system.

  1. stage9 - Run Linux application as common process

Start a simple Linux application (HelloWorld) on top of eduOS-rs. The application is a position-independent executable (PIE) and use musl-libc as standard C library. The FPU support is disabled.

Useful Links

  1. http://www.gnu.org/software/grub/manual/multiboot/
  2. http://www.osdever.net/tutorials/view/brans-kernel-development-tutorial
  3. https://www.acs.eonerc.rwth-aachen.de/cms/e-on-erc-acs/studium/lehrveranstaltungen/~xwyom/grundgebiete-der-informatik-4-betriebs/?lidx=1
  4. http://rwth-os.github.io/eduOS/
  5. https://intermezzos.github.io

License

Licensed under either of

  • Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Owner

  • Name: RWTH Aachen University, OS Research @ ACS
  • Login: RWTH-OS
  • Kind: organization
  • Location: Aachen, Germnay

Part of the Institute for Automation of Complex Power Systems

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lankes"
  given-names: "Stefan"
  orcid: "https://orcid.org/0000-0003-4718-2238"
- family-names: "Klimt"
  given-names: "Jonathan"
  orcid: "https://orcid.org/0000-0002-5980-2214"
- family-names: "Kröning"
  given-names: "Martin"
  orcid: "https://orcid.org/0009-0005-0622-4229"

title: "eduOS-rs - A teaching operating system written in Rust"
version: 0.1.0
doi: 10.5281/zenodo.14675628
date-released: 2025-01-16
url: "https://github.com/RWTH-OS/eduOS-rs"

GitHub Events

Total
  • Create event: 72
  • Issues event: 4
  • Release event: 70
  • Watch event: 30
  • Delete event: 73
  • Issue comment event: 8
  • Push event: 156
  • Pull request event: 7
  • Fork event: 1
Last Year
  • Create event: 72
  • Issues event: 4
  • Release event: 70
  • Watch event: 30
  • Delete event: 73
  • Issue comment event: 8
  • Push event: 156
  • Pull request event: 7
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 359
  • Total Committers: 6
  • Avg Commits per committer: 59.833
  • Development Distribution Score (DDS): 0.017
Past Year
  • Commits: 70
  • Committers: 2
  • Avg Commits per committer: 35.0
  • Development Distribution Score (DDS): 0.014
Top Committers
Name Email Commits
Stefan Lankes s****s@e****e 353
dependabot[bot] 4****] 2
azure-pipelines[bot] a****] 1
Martin Kröning m****g@p****t 1
Jens Breitbart j****t@g****m 1
Simon Pickartz s****z@e****e 1
Committer Domains (Top 20 + Academic)
eonerc.rwth-aachen.de: 2 posteo.net: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 10
  • Total pull requests: 42
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 10
  • Total pull request authors: 8
  • Average comments per issue: 3.1
  • Average comments per pull request: 0.52
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 24
Past Year
  • Issues: 0
  • Pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 21 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.25
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 8
View more stats
Top Authors
Issue Authors
  • stv0g (1)
  • BaderSZ (1)
  • TrebuchKill (1)
  • gongbo2018 (1)
  • 756445638 (1)
  • FutureDragon (1)
  • lwz23 (1)
  • ghost (1)
  • Harry-R (1)
  • ColinFinck (1)
  • WattleFoxxo (1)
Pull Request Authors
  • dependabot[bot] (31)
  • mkroening (10)
  • spickartz (2)
  • ColinFinck (2)
  • stlankes (1)
  • jbreitbart (1)
  • Harry-R (1)
  • ghost (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (31) rust (29) github_actions (2)

Dependencies

Cargo.lock cargo
  • autocfg 1.0.1
  • bit_field 0.10.1
  • bitflags 1.3.2
  • cfg-if 1.0.0
  • goblin 0.0.19
  • lock_api 0.4.6
  • log 0.4.14
  • num-traits 0.2.14
  • plain 0.2.3
  • proc-macro2 0.4.30
  • quote 0.6.13
  • raw-cpuid 10.2.0
  • rustc_version 0.2.3
  • scopeguard 1.1.0
  • scroll 0.9.2
  • scroll_derive 0.9.5
  • semver 0.9.0
  • semver-parser 0.7.0
  • spin 0.9.2
  • syn 0.15.44
  • unicode-xid 0.1.0
  • x86 0.46.0
.github/workflows/format.yml actions
  • actions/checkout v3 composite
.github/workflows/run.yml actions
  • actions/checkout v3 composite
Dockerfile docker
  • ubuntu 22.04 build