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.
248 commits 1 branch 0 tags 1.1 MiB
Zig 96%
Assembly 3.9%
Shell 0.1%
Find a file
DrDeano fab372a6cf
Initial FAT32 interface 
Include code page 437

This is now moved to a better location

Fixed initrd doc for allocator


Added test files

 Plus minor extras

Created initial FAT32 filesystem

This initial FAT32 filesystem will parse a stream, which could be a HDD or a in memory filesystem and produce a FAT32 filesystem. This will check if the raw bytes is a valid FAT32 filesystem as descibed in the spec.

This is only a skeleton with no open, read or write functionality.

Part of #216

logger -> log


Fmt


Removed 'zero_' from struct fields


number_free_cluster -> number_free_clusters


Return non allocated FAT32FS


prefix test_


Added doc comment for boot sector arrays


Moved code_page.zig


info -> debug for init FAT32


Abstracted getting code page table
2020-11-22 21:37:39 +00:00
.github/workflows Initial scheduler 2020-07-18 22:46:24 +01:00
grub Created ramdisk build step 2020-07-25 11:18:19 +01:00
src Initial FAT32 interface 2020-11-22 21:37:39 +00:00
test Initial FAT32 interface 2020-11-22 21:37:39 +00:00
.gitignore imported gitignore 2020-10-19 09:09:03 +01:00
build.zig Rename the logger to log to make is all consistent 2020-11-13 19:16:25 +00:00
hello.jpg Improve readme 2019-09-08 16:26:24 +01:00
makeiso.sh Created ramdisk build step 2020-07-25 11:18:19 +01:00
mkfat32.zig Initial FAT32 interface 2020-11-22 21:37:39 +00:00
README.md Use the standardTargetOptions for built targets 2020-06-23 12:49:40 +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-multiarch instance and connect to qemu.

zig build debug

Unit testing

Run the unit tests.

zig build test

Runtime testing

Run the runtime tests.

zig build rt-test -Dtest-mode=<MODE>

Available test modes:

  • None: This is the default, this will run the OS normally.
  • Initialisation: Run the OS's initialisation runtime tests to ensure the OS is properly set up.
  • Panic: Run the panic runtime test.

Options

  • -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.
  • -Dtarget=: String (default i386-freestanding). The standard target options for building with zig. Currently supported targets:
    • i386-freestanding
  • -Ddisable-display: Boolean (default false)
    • This disables the display output of QEMU.

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