acadia/README.md

41 lines
1.7 KiB
Markdown
Raw Normal View History

2023-05-31 00:03:44 -07:00
# AcadiaOS
2023-10-24 22:56:45 -07:00
AcadiaOS is a hobby operating system I use to explore and learn about OS development.
2023-05-31 00:03:44 -07:00
2023-10-24 22:56:45 -07:00
It is built on top of a small capability-based microkernel that provides
memory management, process scheduling, and hardware access.
## Directory Structure
The subdirectories of the project are as follows:
- **zion**: Contains kernel code as well as a couple headers that user space uses to interface with the kernel.
- **lib**: Library code used by the kernel and user space.
- **sys**: System services.
- **sysroot**: Files that are copied to the root filesystem.
- **toolchain** and **scripts**: Contain tooling for the cross-compile environment.
- **yunq**: Contains the El Yunque IDL used for IPC between processes in userspace.
Where available, further documentation about each of these components can be found in the README files in each respective subdirectory.
## Building AcadiaOS
Run `./scripts/build_toolchain.sh` to build a gcc cross-compile toolchain for the project. (Takes a long time.)
Change into the `build-dbg` directory.
Run `ninja qemu` to build and run AcadiaOS in a VM.
### System Dependencies
TODO
## Boot Process
AcadiaOS uses the limine bootloader to enter into a 64-bit kernel in the negative 2GB address space (mcmodel kernel).
The Zion kernel then sets up interrupts, scheduling, and memory management before passing off control to the Yellowstone process.
The kernel passes capabilities to the Denali and VictoriaFalls binaries to the Yellowstone process to allow it to manage the rest of the boot process.
The Yellowstone, Denali, and VictoriaFalls processes are all passed at boot using limine modules, however any subsequent processes will be loaded off disk.