Hobby operating system for x86_64

Go to file

Bananymous aa7a8124ce Bootloader: Add helpers for printing n bit hexadecimal numbers		2023-11-16 13:30:01 +02:00
BAN	BAN: Update bytespan -> span API	2023-11-04 18:12:46 +02:00
LibELF	fixup	2023-11-13 21:39:48 +02:00
assets	Update README.md	2023-08-31 17:54:12 +03:00
bootloader	Bootloader: Add helpers for printing n bit hexadecimal numbers	2023-11-16 13:30:01 +02:00
kernel	Kernel/LibC: Implement readlink and readlinkat	2023-11-11 23:16:52 +02:00
libc	Kernel/LibC: Implement readlink and readlinkat	2023-11-11 23:16:52 +02:00
script	Bootloader: Build with cmake instead of custom script	2023-11-14 03:44:47 +02:00
toolchain	Toolchain: Fix typo when setting make flags	2023-11-09 21:57:45 +02:00
userspace	ls: print link targets when listing files	2023-11-11 23:17:18 +02:00
.gitignore	BuildSystem: using sysroot doesn't need root privileges anymore!	2023-11-04 17:50:43 +02:00
.gitmodules	Kernel: Add LAI as a dependency	2023-09-22 17:20:35 +03:00
CMakeLists.txt	Bootloader: Build with cmake instead of custom script	2023-11-14 03:44:47 +02:00
LICENCE	Create LICENCE	2023-04-13 00:38:24 +03:00
README.md	BuildSystem: using sysroot doesn't need root privileges anymore!	2023-11-04 17:50:43 +02:00
base-sysroot.tar.gz	BuildSystem: add cmake variable UEFI_BOOT	2023-10-16 01:44:54 +03:00
bos	BuildSystem: Add bos short hand for building with zsh completions :)	2023-10-28 22:23:29 +03:00

README.md

banan-os

This is my hobby operating system written in C++. Currently supports only x86_64 architecture. We have a ext2 filesystem, basic ramfs, IDE disk drivers in ATA PIO mode, ATA AHCI drivers, userspace processes, executable loading from ELF format, linear VBE graphics and multithreaded processing on single core.

Code structure

Each major component and library has its own subdirectory (kernel, userspace, libc, ...). Each directory contains directory include, which has all of the header files of the component. Every header is included by its absolute path.

Building

There does not exist a complete list of needed packages for building. From the top of my head I can say that cmake, ninja, make, grub, rsync and emulator (qemu or bochs) are needed.

To build the toolchain for this os. You can run the following command.

NOTE: The following step has to be done only once. This might take a long time since we are compiling binutils and gcc.

./script/build.sh toolchain

To build the os itself you can run one of the following commands. You will need root access for disk image creation/modification.

./script/build.sh qemu
./script/build.sh qemu-nographic
./script/build.sh qemu-debug
./script/build.sh bochs

You can also build the kernel or disk image without running it:

./script/build.sh kernel
./script/build.sh image

If you have corrupted your disk image or want to create new one, you can either manually delete build/banan-os.img and build system will automatically create you a new one or you can run the following command.

./script/build.sh image-full

If you feel like ./script/build.sh is too verbose, there exists a symlink bos in this projects root directory. All build commands can be used with ./bos args... instead.

I have also created shell completion script for zsh. You can either copy the file in script/shell-completion/zsh/_bos to /usr/share/zsh/site-functions/ or add the script/shell-completion/zsh to your fpath in .zshrc.

Contributing

Currently I don't accept contributions to this repository unless explicitly told otherwise. This is a learning project for me and I want to do everything myself. Feel free to fork/clone this repo and tinker with it yourself.