pluto/README.md

79 lines
2.9 KiB
Markdown
Raw Normal View History

# Pluto
2019-09-17 19:49:53 +02:00
[![Build Status](https://github.com/SamTebbs33/pluto/workflows/CI/badge.svg)](https://github.com/SamTebbs33/pluto/actions)
2019-09-08 00:38:12 +02:00
Pluto is a kernel written almost entirely in [Zig](https://github.com/ziglang/zig) and supports x86, with aarch64 and x64 backends being planned.
![Hello image](hello.jpg)
## Goals
2019-09-08 00:38:12 +02:00
* **Should be written in Zig as much as possible**. Assembly should only be used where required for functionality or performance reasons.
* **Light and performant**. The kernel should be usable both on embedded and desktop class CPUs, made possible by it being lightweight and modular.
* **Basic utilities will be written in Zig**. This includes a basic text editor and shell, and will be part of the filesystem external to the kernel itself.
* **Easy to port**. The kernel is oblivious to the underlying architecture, meaning that ports only need to implement the defined interface and they should work without a hitch.
2019-09-08 00:38:12 +02:00
All of these goals will benefit from the features of Zig.
## Build
2019-10-10 22:20:17 +02:00
Requires a master build of Zig ([downloaded](https://ziglang.org/download) or [built from source](https://github.com/ziglang/zig#building-from-source)) *xorriso* and the grub tools (such as *grub-mkrescue*). A *qemu-system* binary compatible with your chosen target is required to run the kernel (e.g. *qemu-system-i386*).
```Shell
zig build
```
## Run
```Shell
zig build run
```
2019-10-10 22:20:17 +02:00
or if you want to wait for a gdb connection:
```Shell
zig build debug-run
```
2019-09-08 00:38:12 +02:00
## Debug
2020-06-02 22:16:37 +02:00
Launch a gdb-multiarch instance and connect to qemu.
```Shell
zig build debug
```
2019-09-08 00:38:12 +02:00
## Test
Run the unit tests or runtime tests.
```Shell
zig build test
```
2019-09-08 00:38:12 +02:00
## Options
2019-09-08 00:38:12 +02:00
* `-Drt-test=`: Boolean (default `false`).
* **build**: Build with runtime testing enabled. Makes the kernel bigger and slower but tests important functionality.
2020-06-02 22:16:37 +02:00
* **test**: Run the runtime testing script instead of the unit tests. Checks for the expected log statements and fails if any are missing.
2019-10-10 22:20:17 +02:00
* `-D[build-mode]=`: Boolean (default `false`).
* **build**: Build a certain build mode (*release-safe*, *release-fast*, *release-small*). Don't set in order to use the *debug* build mode.
* **test**: Test a certain build mode (*release-safe*, *release-fast*, *release-small*). Don't set in order to use the *debug* build mode.
2020-06-02 22:16:37 +02:00
* `-Darch=`: String (default `x86`). Currently the only supported value is `x86`.
* **build**: Build for a certain architecture.
* **test**: Test a certain architecture.
2019-09-08 00:38:12 +02:00
## Contribution
2019-09-08 00:38:12 +02:00
We welcome all contributions, be it bug reports, feature suggestions or pull requests. We follow the style mandated by zig fmt so make sure you've run `zig fmt` on your code before submitting it.
We also like to order a file's members (public after non-public):
2019-09-08 00:38:12 +02:00
1. imports
2. type definitions
3. constants
4. variables
5. inline functions
6. functions
7. entry point/init function
2019-10-10 22:20:17 +02:00
More styling information is available on the [wiki](https://github.com/SamTebbs33/pluto/wiki/Code-Styling-(Detailed))