2020-01-29 22:16:15 +00:00
|
|
|
# MOROS: Obscure Rust Operating System
|
2019-12-28 17:08:11 +00:00
|
|
|
|
2021-11-01 07:58:22 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
MOROS is a hobby operating system written in Rust by [Vincent Ollivier](https://vinc.cc).
|
2020-11-14 21:09:08 +00:00
|
|
|
|
2021-11-01 07:58:22 +00:00
|
|
|
It targets computers with a x86-64 architecture and a BIOS, so mostly from 2005
|
|
|
|
|
to 2020, but it also runs well on most emulators (Bochs, QEMU, and VirtualBox).
|
2020-02-02 17:55:20 +00:00
|
|
|
|
2020-02-02 18:22:27 +00:00
|
|
|
This project started from the [seventh post][1] of the second edition of
|
|
|
|
|
[Writing an OS in Rust][2] by Philipp Oppermann and by reading the
|
|
|
|
|
[OSDev wiki][3] along with many open source kernels.
|
|
|
|
|
|
2021-11-01 07:58:22 +00:00
|
|
|
[](https://travis-ci.org/vinc/moros/branches)
|
|
|
|
|
[](https://crates.io/crates/moros)
|
2020-07-05 11:31:49 +00:00
|
|
|
|
2022-08-28 15:26:13 +00:00
|
|
|
|
2020-02-02 18:22:27 +00:00
|
|
|
## Features
|
2020-02-02 17:55:20 +00:00
|
|
|
|
2020-02-02 18:22:27 +00:00
|
|
|
- [x] External bootloader (using [bootloader](https://github.com/rust-osdev/bootloader))
|
|
|
|
|
- [x] x86 CPU support (using [x86_64](https://crates.io/crates/x86_64))
|
2021-06-27 14:32:47 +00:00
|
|
|
- [x] Hardware interrupts (using [pic8259](https://crates.io/crates/pic8259))
|
2021-12-29 21:56:08 +00:00
|
|
|
- [x] PS/2 Keyboard with customizable layout (using [pc-keyboard](https://crates.io/crates/pc-keyboard))
|
|
|
|
|
- [x] VGA Text mode with customizable font and color palette
|
2020-02-02 18:22:27 +00:00
|
|
|
- [x] Serial output (using [uart_16550](https://crates.io/crates/uart_16550))
|
2020-02-02 17:55:20 +00:00
|
|
|
- [x] Paging
|
2020-02-02 18:22:27 +00:00
|
|
|
- [x] Heap allocation (using [linked_list_allocator](https://crates.io/crates/linked_list_allocator))
|
2020-11-08 17:51:09 +00:00
|
|
|
- [x] ACPI shutdown (using [acpi](https://crates.io/crates/acpi) and [aml](https://crates.io/crates/aml))
|
2020-02-02 17:55:20 +00:00
|
|
|
- [x] RTC clock
|
2021-12-29 21:56:08 +00:00
|
|
|
- [x] PCI devices
|
2020-02-02 17:55:20 +00:00
|
|
|
- [x] ATA PIO mode
|
2022-07-02 05:16:58 +00:00
|
|
|
- [x] Random number generator (using [rand_hc](https://crates.io/crates/rand_hc))
|
2020-02-02 17:55:20 +00:00
|
|
|
- [x] RTL8139 network card
|
2020-10-31 22:20:41 +00:00
|
|
|
- [x] AMD PCNET network card
|
2021-12-29 21:56:08 +00:00
|
|
|
- [x] DHCP/IP/TCP/UDP/DNS/HTTP network protocols (using [smoltcp](https://crates.io/crates/smoltcp))
|
|
|
|
|
- [x] Basic [filesystem](doc/filesystem.md)
|
|
|
|
|
- [x] Basic [shell](doc/shell.md)
|
|
|
|
|
- [x] Basic [text editor](doc/editor.md)
|
|
|
|
|
- [x] Basic [lisp](doc/lisp.md) interpreter
|
|
|
|
|
- [x] Basic file and [network](doc/network.md) commands
|
2022-06-16 17:42:10 +00:00
|
|
|
- [x] Basic userspace for NASM and Rust programs without alloc
|
|
|
|
|
- [ ] Multitasking
|
2021-12-29 21:56:08 +00:00
|
|
|
- [ ] C standard library port
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
Documentation is available [here](doc/index.md)
|
2019-12-29 10:16:59 +00:00
|
|
|
|
2020-07-05 11:31:49 +00:00
|
|
|
|
2020-02-03 20:18:06 +00:00
|
|
|
## Setup
|
2019-12-28 17:08:11 +00:00
|
|
|
|
2021-12-29 21:56:08 +00:00
|
|
|
Clone the repo:
|
|
|
|
|
|
|
|
|
|
$ git clone https://github.com/vinc/moros
|
|
|
|
|
$ cd moros
|
|
|
|
|
|
|
|
|
|
Install the required tools with `make setup` or the following commands:
|
2019-12-28 17:08:11 +00:00
|
|
|
|
2020-07-05 11:31:49 +00:00
|
|
|
$ curl https://sh.rustup.rs -sSf | sh
|
|
|
|
|
$ rustup install nightly
|
|
|
|
|
$ rustup default nightly
|
2020-07-31 08:31:59 +00:00
|
|
|
$ cargo install bootimage
|
|
|
|
|
|
2019-12-28 17:08:11 +00:00
|
|
|
|
2020-02-03 20:18:06 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2020-11-14 21:05:05 +00:00
|
|
|
Build the image to `disk.img`:
|
2020-01-15 21:33:48 +00:00
|
|
|
|
2022-05-05 21:05:39 +00:00
|
|
|
$ make image output=video keyboard=qwerty
|
2020-01-15 21:33:48 +00:00
|
|
|
|
2020-11-14 21:05:05 +00:00
|
|
|
Run MOROS in QEMU:
|
2020-01-15 21:33:48 +00:00
|
|
|
|
2021-07-13 20:10:02 +00:00
|
|
|
$ make qemu output=video nic=rtl8139
|
2020-02-03 20:18:06 +00:00
|
|
|
|
2020-11-14 21:05:05 +00:00
|
|
|
Run natively on a x86 computer by copying the bootloader and the kernel to a
|
|
|
|
|
hard drive or USB stick (but there is currently no USB driver so the filesystem
|
2021-12-29 21:56:08 +00:00
|
|
|
will not be available in that case):
|
2020-01-15 21:33:48 +00:00
|
|
|
|
2020-07-05 11:31:49 +00:00
|
|
|
$ sudo dd if=target/x86_64-moros/release/bootimage-moros.bin of=/dev/sdx && sync
|
|
|
|
|
|
2021-12-29 21:56:08 +00:00
|
|
|
MOROS will open a console in diskless mode after boot if no filesystem is
|
|
|
|
|
detected. The following command will setup the filesystem on a hard drive,
|
|
|
|
|
allowing you to exit the diskless mode and log in as a normal user:
|
2020-07-05 11:31:49 +00:00
|
|
|
|
|
|
|
|
> install
|
2019-12-29 10:16:59 +00:00
|
|
|
|
2020-02-15 09:52:49 +00:00
|
|
|
**Be careful not to overwrite the hard drive of your OS when using `dd` inside
|
2021-12-29 21:56:08 +00:00
|
|
|
your OS, and `install` or `disk format` inside MOROS if you don't use an
|
|
|
|
|
emulator.**
|
2020-07-05 11:31:49 +00:00
|
|
|
|
2019-12-29 10:16:59 +00:00
|
|
|
|
2020-11-14 21:05:05 +00:00
|
|
|
## Tests
|
|
|
|
|
|
|
|
|
|
Run the test suite in QEMU:
|
|
|
|
|
|
|
|
|
|
$ make test
|
|
|
|
|
|
|
|
|
|
|
2022-08-28 15:26:13 +00:00
|
|
|
## License
|
2019-12-29 10:16:59 +00:00
|
|
|
|
|
|
|
|
MOROS is released under MIT.
|
|
|
|
|
|
|
|
|
|
[1]: https://github.com/phil-opp/blog_os/tree/post-07
|
|
|
|
|
[2]: https://os.phil-opp.com
|
2020-02-02 18:22:27 +00:00
|
|
|
[3]: https://wiki.osdev.org
|
