https://github.com/dentosal/rust_os
My hobby operating system microkernel written in Rust
https://github.com/dentosal/rust_os
hobby-project microkernel operating-system osdev rust
Last synced: 2 months ago
JSON representation
My hobby operating system microkernel written in Rust
- Host: GitHub
- URL: https://github.com/dentosal/rust_os
- Owner: Dentosal
- License: mit
- Created: 2016-01-20T09:09:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T02:24:59.000Z (about 2 years ago)
- Last Synced: 2025-03-18T11:38:47.629Z (2 months ago)
- Topics: hobby-project, microkernel, operating-system, osdev, rust
- Language: Rust
- Homepage:
- Size: 1.06 MB
- Stars: 44
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# D7 operating system 
Operating system for modern x86-64 computers, written in Rust.
## Current features:
* Multitasking: tickless event-driven round-robin scheduler
* Executable programs, in ELF format
* IPC: PubSub messaging and named pipes
* Keyboard input
* Virtual TTYs
* Disk IO:
* ATA PIO
* VirtIO-blk (Read only)
* Networking:
* Drivers for NE2000 and RTL8139
* IPv4 stack, supporting TCP, UDP, DNS, DHCP, ARP
* Services
* Serviced - startup and service status queries
* Netd - Manages network interfaces and sockets
## Roadmap items:
* Shell
* Virtual filesystem
* Automated test suite
* Porting software
* Shell utilities
* Text editor
* Compilers
* Self-hosting
* (Better) support for...
* Filesystems:
* ramfs
* ext2
* some network filesystem, possibly a custom one
* NICs:
* Intel E1000 driver
* VirtIO-net driver
* USB and Audio devices
# Development
This is a learning project. Currently code contributions are not accepted, as I'd like to learn to fix the problems myself. Forking the project is of course possible, if you'd like to develop something based on this.
Feel free to submit issues on GitHub if you find any bugs.
# Compiling and Running
The project is using Vagrant to virtualize the building environment. While being a little slower, this means that building the system on any supported platform should Just Work™. If you have a Unix-like system, install Qemu and
```bash
git clone https://github.com/Dentosal/rust_os.git && cd rust_os && ./autobuild.sh -ug
```
Sometimes shared folder feature will not work, and you get an error message about missing `/vagrant` etc. In that case installing vbguest plugin should help:
```bash
vagrant plugin install vagrant-vbguest
```
If you don't have a Unix-like system, then you should probably get one, they are pretty awesome compared to old DOS systems or [Dentosal/rust_os](https://github.com/Dentosal/rust_os/). However, building on WSL is also possible. Just install the required tools (see [Vagrantfile](Vagrantfile)), and the run `./autobuild.sh -n`
## Dependencies
Building with default automated build system required that Vagrant is installed. I use VirtualBox as my Vagrant provider, but [other providers](https://www.vagrantup.com/docs/providers/) should work as well.
Vagrant isn't actually required: on systems with apt, like Debian or Ubuntu, it should be reasonably easy to just install the dependencies by hand. The install script can be found from `Vagrantfile`.
You will also need a virtual machine. Qemu is suggested, but Bochs should work as well. VirtualBox can also be used, but the project isn't actively tested with it. Moreover, you must run it yourself.
## Actually running
With Qemu and Vagrant installed, run `./autobuild.sh -ug`. With Bochs: `./autobuild.sh -ugb`. To use VirtualBox, run `./autobuild.sh -ugv`.
## Local development without Vagrant
```bash
cargo fmt && ./autobuild.sh
```
# License
This project is licensed under the MIT license, which can be found in the file called LICENSE.