cernel: x64 Toy kernel

cernel is a tiny x64 toy kernel which helps us to gain a better knowledge about kernel and os development.

At this point you can work on it with Linux or WSL, the Makefile has been optimized for WSL. Whether Windows would work natively I haven't tried yet, but feel free to include support for development on Windows.

Build requirements

These are the tools needed for the build:

git (for initial download)
make
gcc (for building gcc on your own)
qemu (for testing)

You also need this packages for building gcc, if they are not already installed

uuid-dev
libfuse-dev
libmpfr-dev
libmpc-dev
libgmp-dev

nasm is getting build via our toolchain

If you use macOS you will need these packages instead:

git
make
qemu
x86_64-elf-gdb
x86_64-elf-gcc
x86_64-elf-binutils
nasm
xorriso

The builds steps on macOS are exactly the same as on Linux

# Clone the repository where you like
git clone https://github.com/Lockna/cernel --recurse-submodules
cd cernel
# Make the toolchain, so the kernel can be compiled with this tools
# Since we have more dependencies on macOS, we only build limine in make toolchain, not the whole toolchain
make toolchain
# Make the kernel, you can provide -j
make
# For creating a release build
make RELEASE=yes
# You can run the kernel either with make run or make drun
make run

The difference between make run and make drun is, that make drun creates a gdb server, where you can connect to. This will look something like this

# This terminal will open qemu, which will say "Guest has not initialized the display (yet).
make drun

# Open a new terminal and enter gdb with the cernel.elf file loaded
cd cernel/kernel/
gdb cernel.elf
gdb> target remote :1234
gdb> break * _start
# And now you can start debugging using gdb

Contact

Feel free to reach out to Lockna#5599 or mp#2453 on Discord

Contributing

Contributions to code and documentation are heavily appreciated, may it be a bug fix or a improvent of the existing code or code documentation. New features would be gladly taken over by us, as the project was created for exactly this purpose.

License

This software is licensed unter the terms of the MIT License