|
|
|
@@ -6,38 +6,42 @@
|
|
|
|
<b>H2O</b>
|
|
|
|
<b>H2O</b>
|
|
|
|
</p>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
Elyz is a microkernel operating system written in Rust. The project uses the Limine bootloader and supports multiple architectures. The current implementation includes basic kernel initialization, physical memory management, paging, and graphical output via framebuffer.
|
|
|
|
**Elyz is a microkernel OS** that radically rejects the technological deadwood of the past. While traditional systems are hamstrung by decades of legacy code, Elyz is built on a foundation of uncompromising modernity.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
We implement technologies that others can't afford. This isn't an attempt to fix the old, but to create a flexible and secure environment, building a proper OS from scratch, capable of instantly adapting to the challenges of tomorrow.
|
|
|
|
|
|
|
|
|
|
|
|
## Project Structure
|
|
|
|
## Project Structure
|
|
|
|
|
|
|
|
|
|
|
|
| Directory/File | Description |
|
|
|
|
| Directory/File | Description |
|
|
|
|
|----------------|-------------|
|
|
|
|
| -------------- | -------------------------------------- |
|
|
|
|
| `kernel/` | Kernel source code (Rust) |
|
|
|
|
| `kernel/` | Kernel source code |
|
|
|
|
| `limine/` | Limine bootloader |
|
|
|
|
| `limine/` | Limine bootloader |
|
|
|
|
| `ovmf/` | UEFI firmware for emulation |
|
|
|
|
| `ovmf/` | UEFI firmware for emulation |
|
|
|
|
| `limine.conf` | Boot menu configuration |
|
|
|
|
| `limine.conf` | Boot menu configuration |
|
|
|
|
| `GNUmakefile` | Main Makefile for building and running |
|
|
|
|
| `GNUmakefile` | Main Makefile for building and running |
|
|
|
|
|
|
|
|
|
|
|
|
## System Requirements
|
|
|
|
## System Requirements
|
|
|
|
|
|
|
|
|
|
|
|
| Tool | Version/Requirements | Purpose |
|
|
|
|
| Tool | Version/Requirements | Purpose |
|
|
|
|
|------|---------------------|---------|
|
|
|
|
| -------- | ----------------------- | ------------------- |
|
|
|
|
| GNU Make | ≥ 4.0 | Project building |
|
|
|
|
| GNU Make | ≥ 4.0 | Project building |
|
|
|
|
| Rust | Nightly with `rust-src` | Kernel compilation |
|
|
|
|
| Rust | Nightly with `rust-src` | Kernel compilation |
|
|
|
|
| xorriso | Any | ISO image creation |
|
|
|
|
| xorriso | Any | ISO image creation |
|
|
|
|
| sgdisk | Any | Disk image creation |
|
|
|
|
| sgdisk | Any | Disk image creation |
|
|
|
|
| mtools | Any | Disk image handling |
|
|
|
|
| mtools | Any | Disk image handling |
|
|
|
|
| QEMU | ≥ 6.0 | Emulation |
|
|
|
|
| QEMU | ≥ 6.0 | Emulation |
|
|
|
|
|
|
|
|
|
|
|
|
**Installing dependencies:**
|
|
|
|
**Installing dependencies:**
|
|
|
|
|
|
|
|
|
|
|
|
**Ubuntu/Debian:**
|
|
|
|
**Ubuntu/Debian:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
sudo apt install make rustc xorriso gdisk mtools qemu-system-x86
|
|
|
|
sudo apt install make rustc xorriso gdisk mtools qemu-system-x86
|
|
|
|
rustup toolchain install nightly --component rust-src
|
|
|
|
rustup toolchain install nightly --component rust-src
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
**Arch Linux:**
|
|
|
|
**Arch Linux:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
sudo pacman -S make rust xorriso gdisk mtools qemu-desktop
|
|
|
|
sudo pacman -S make rust xorriso gdisk mtools qemu-desktop
|
|
|
|
rustup toolchain install nightly --component rust-src
|
|
|
|
rustup toolchain install nightly --component rust-src
|
|
|
|
@@ -46,6 +50,7 @@ rustup toolchain install nightly --component rust-src
|
|
|
|
## Building and Running
|
|
|
|
## Building and Running
|
|
|
|
|
|
|
|
|
|
|
|
### Preparation
|
|
|
|
### Preparation
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
git clone https://git.inotfail.com/INotFail/Elyz.git
|
|
|
|
git clone https://git.inotfail.com/INotFail/Elyz.git
|
|
|
|
cd Elyz
|
|
|
|
cd Elyz
|
|
|
|
@@ -54,17 +59,18 @@ rustup override set nightly
|
|
|
|
|
|
|
|
|
|
|
|
### Main Makefile Targets
|
|
|
|
### Main Makefile Targets
|
|
|
|
|
|
|
|
|
|
|
|
| Target | Description | Result |
|
|
|
|
| Target | Description | Result |
|
|
|
|
|--------|-------------|--------|
|
|
|
|
| --------------- | --------------------------------- | -------------- |
|
|
|
|
| `make all` | Kernel compilation + ISO creation | `Elyz.iso` |
|
|
|
|
| `make all` | Kernel compilation + ISO creation | `Elyz.iso` |
|
|
|
|
| `make run` | Full build + QEMU launch (BIOS) | UEFI emulation |
|
|
|
|
| `make run` | Full build + QEMU launch (BIOS) | UEFI emulation |
|
|
|
|
| `make run-bios` | Run existing image (BIOS) | BIOS emulation |
|
|
|
|
| `make run-bios` | Run existing image (BIOS) | BIOS emulation |
|
|
|
|
| `make run-uefi` | Full build + QEMU launch (UEFI) | UEFI emulation |
|
|
|
|
| `make run-uefi` | Full build + QEMU launch (UEFI) | UEFI emulation |
|
|
|
|
| `make all-hdd` | Compilation + HDD/USB image | `Elyz.hdd` |
|
|
|
|
| `make all-hdd` | Compilation + HDD/USB image | `Elyz.hdd` |
|
|
|
|
| `make run-hdd` | Build HDD + QEMU launch | HDD emulation |
|
|
|
|
| `make run-hdd` | Build HDD + QEMU launch | HDD emulation |
|
|
|
|
| `make clean` | Clean build artifacts | — |
|
|
|
|
| `make clean` | Clean build artifacts | — |
|
|
|
|
|
|
|
|
|
|
|
|
**Run examples:**
|
|
|
|
**Run examples:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
# BIOS with auto-build
|
|
|
|
# BIOS with auto-build
|
|
|
|
make run
|
|
|
|
make run
|
|
|
|
@@ -80,14 +86,15 @@ make all-hdd
|
|
|
|
|
|
|
|
|
|
|
|
The `KARCH` environment variable sets the target architecture (default: `x86_64`).
|
|
|
|
The `KARCH` environment variable sets the target architecture (default: `x86_64`).
|
|
|
|
|
|
|
|
|
|
|
|
| Architecture | `KARCH` value | Status |
|
|
|
|
| Architecture | `KARCH` value | Status |
|
|
|
|
|--------------|---------------|--------|
|
|
|
|
| ------------ | ------------- | ------------ |
|
|
|
|
| x86_64 | `x86_64` | Full support |
|
|
|
|
| x86_64 | `x86_64` | Full support |
|
|
|
|
| AArch64 | `aarch64` | Experimental |
|
|
|
|
| AArch64 | `aarch64` | Experimental |
|
|
|
|
| RISC-V 64 | `riscv64` | Experimental |
|
|
|
|
| RISC-V 64 | `riscv64` | Experimental |
|
|
|
|
| LoongArch 64 | `loongarch64` | Experimental |
|
|
|
|
| LoongArch 64 | `loongarch64` | Experimental |
|
|
|
|
|
|
|
|
|
|
|
|
**Running other architecture:**
|
|
|
|
**Running other architecture:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
make run KARCH=aarch64
|
|
|
|
make run KARCH=aarch64
|
|
|
|
```
|
|
|
|
```
|
|
|
|
@@ -96,28 +103,28 @@ make run KARCH=aarch64
|
|
|
|
|
|
|
|
|
|
|
|
## Current Functionality
|
|
|
|
## Current Functionality
|
|
|
|
|
|
|
|
|
|
|
|
| Component | Status | Description |
|
|
|
|
| Component | Status | Description |
|
|
|
|
|-----------|--------|-------------|
|
|
|
|
| -------------------- | ------- | -------------------------- |
|
|
|
|
| Limine Bootloader | ✅ Done | BIOS/UEFI support |
|
|
|
|
| Limine Bootloader | ✅ Done | BIOS/UEFI support |
|
|
|
|
| Physical MM (Bitmap) | ✅ Done | Page bitmap |
|
|
|
|
| Physical MM (Bitmap) | ✅ Done | Page bitmap |
|
|
|
|
| Page Tables (x86_64) | ✅ Done | 4-level addressing |
|
|
|
|
| Page Tables (x86_64) | ✅ Done | 4-level addressing |
|
|
|
|
| Global Allocator | ✅ Done | Bump allocator (8MB) |
|
|
|
|
| Global Allocator | ✅ Done | Bump allocator (8MB) |
|
|
|
|
| Framebuffer | ✅ Done | Graphical output |
|
|
|
|
| Framebuffer | ✅ Done | Graphical output |
|
|
|
|
| Console | ✅ Done | Text output with scrolling |
|
|
|
|
| Console | ✅ Done | Text output with scrolling |
|
|
|
|
|
|
|
|
|
|
|
|
## Memory System Development Status
|
|
|
|
## Memory System Development Status
|
|
|
|
|
|
|
|
|
|
|
|
| Task | Status | Note |
|
|
|
|
| Task | Status | Note |
|
|
|
|
|------|--------|------|
|
|
|
|
| --------------------------- | -------------- | ----------------------- |
|
|
|
|
| **Basic initialization** | ✅ Ready | Limine, MMU, PMM |
|
|
|
|
| **Basic initialization** | ✅ Ready | Limine, MMU, PMM |
|
|
|
|
| **Physical allocator** | ✅ Ready | BitmapPMM working |
|
|
|
|
| **Physical allocator** | ✅ Ready | BitmapPMM working |
|
|
|
|
| **Paging** | ✅ Ready | P4->P1 mapping |
|
|
|
|
| **Paging** | ✅ Ready | P4->P1 mapping |
|
|
|
|
| **Global heap** | ✅ Ready | 8MB bump allocator |
|
|
|
|
| **Global heap** | ✅ Ready | 8MB bump allocator |
|
|
|
|
| **Descriptor memory model** | ⏳ Not Started | Planned |
|
|
|
|
| **Descriptor memory model** | ⏳ Not Started | Planned |
|
|
|
|
| **Processes and spaces** | ⏳ Not Started | No IPC |
|
|
|
|
| **Processes and spaces** | ⏳ Not Started | No IPC |
|
|
|
|
| **Memory syscalls** | ⏳ Not Started | allocate/clone/transfer |
|
|
|
|
| **Memory syscalls** | ⏳ Not Started | allocate/clone/transfer |
|
|
|
|
| **Weak references** | ⏳ Not Started | borrow/release |
|
|
|
|
| **Weak references** | ⏳ Not Started | borrow/release |
|
|
|
|
| **Process auto-cleanup** | ⏳ Not Started | On exit |
|
|
|
|
| **Process auto-cleanup** | ⏳ Not Started | On exit |
|
|
|
|
|
|
|
|
|
|
|
|
## Development Plan (TODO)
|
|
|
|
## Development Plan (TODO)
|
|
|
|
|
|
|
|
|
|
|
|
@@ -147,6 +154,7 @@ make run KARCH=aarch64
|
|
|
|
**Logs are output to QEMU console.** Panic output via serial port (COM1).
|
|
|
|
**Logs are output to QEMU console.** Panic output via serial port (COM1).
|
|
|
|
|
|
|
|
|
|
|
|
**Useful QEMU options:**
|
|
|
|
**Useful QEMU options:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
# Serial port for logs
|
|
|
|
# Serial port for logs
|
|
|
|
make run QEMU_FLAGS="-serial stdio"
|
|
|
|
make run QEMU_FLAGS="-serial stdio"
|
|
|
|
@@ -156,15 +164,17 @@ make run QEMU_FLAGS="-s -S"
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
**Cleanup:**
|
|
|
|
**Cleanup:**
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
make clean # Remove all artifacts
|
|
|
|
make clean # Remove all artifacts
|
|
|
|
make distclean # + git clean
|
|
|
|
make distclean # + git clean
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Links
|
|
|
|
## Links
|
|
|
|
|
|
|
|
|
|
|
|
- Original Repository: https://git.inotfail.com/INotFail/Elyz
|
|
|
|
- Original Repository: https://git.inotfail.com/INotFail/Elyz
|
|
|
|
|
|
|
|
|
|
|
|
- Related projects:
|
|
|
|
- Related projects:
|
|
|
|
|
|
|
|
|
|
|
|
- Original template with bootloader: https://github.com/jasondyoungberg/limine-rust-template
|
|
|
|
- Original template with bootloader: https://github.com/jasondyoungberg/limine-rust-template
|
|
|
|
|
|
|
|
|
|
|
|
|