Imbus/pluto
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple kernel. Porting to Zig 0.14 in progress.
119 commits 1 branch 0 tags 1.1 MiB
Zig 96%
Assembly 3.9%
Shell 0.1%
Find a file
Edward Dean aca2cc11d2
Merge pull request #123 from SamTebbs33/feature/real-time-clock 
Added RTC
2020-01-15 19:56:42 +00:00
.github/workflows Run unit tests under the building architecture 2020-01-09 13:08:11 +00:00
grub Add simple stacktrace logging 2019-12-06 20:28:28 +00:00
src Added RTC 2020-01-15 19:50:47 +00:00
test Added RTC 2020-01-15 19:50:47 +00:00
.gitignore Add runtime testing harness 2019-07-09 23:25:52 +01:00
build.zig Add Format set to build 2020-01-15 16:30:30 +00:00
hello.jpg Improve readme 2019-09-08 16:26:24 +01:00
link.ld Add x86 paging 2019-06-29 12:02:42 +01:00
makeiso.sh Run unit tests under the building architecture 2020-01-09 13:08:11 +00:00
README.md Fix some readme issues 2019-10-11 17:33:36 +01:00

README.md

Pluto

Build Status

Pluto is a kernel written almost entirely in Zig and supports x86, with aarch64 and x64 backends being planned.

Hello image

Goals

  • 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.

All of these goals will benefit from the features of Zig.

Build

Requires a master build of Zig (downloaded or built 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).

zig build

Run

zig build run

or if you want to wait for a gdb connection:

zig build debug-run

Debug

Launch a gdb instance and connect to qemu.

zig build debug

Test

Run the unit tests or runtime tests.

zig build test

Options

  • -Drt-test=: Boolean (default false).
    • build: Build with runtime testing enabled. Makes the kernel bigger and slower but tests important functionality.
    • test: Run the runtime testing script instead of the unittests. Checks for the expected log statements and fails if any are missing.
  • -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.

Contribution

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):

  1. imports
  2. type definitions
  3. constants
  4. variables
  5. inline functions
  6. functions
  7. entry point/init function

More styling information is available on the wiki