Kerosene

A WIP hobby x86 monolithic OS.

Features

• basic framebuffer video driver
• PS/2 keyboard driver
• RTC clock
• ATA PIO mode
• support FAT32 filesystem
• round-robin scheduler
• support blocking I/O
• user processes and memory space isolation between them
• various syscalls to interact with the virtual filesystem and the scheduler

see features.md for more.

Build and run

Prerequisite

• a GCC cross compiler. although preinstalled GCC on linux will compile it just fine, the osdev wiki said we should use a cross compiler to avoid any unexpected errors.
  • if you are lazy to install one, use make all NO_CROSS_COMPILER=1 to compile using linux GCC.
  • if you have cross compiling tools then please check and correct the CROSS_COMPILER_LOC in .env
• nasm
• dosfstools
• grub (and xorriso to gen iso image)
• qemu

Build and run

Note

• This project is only built and tested on a linux machine (arch btw). Maybe on Windows with WSL or other OS will build and run just fine, though it is not guaranteed.
• script/gendiskimage.sh needs sudo privilege to format and install GRUB to the disk image.

make sure to source enviroment vars before doing anything. shell scripts depend heavily on them. you don't need to do this if running make though.

cp example.env .env
export $(grep -v '^#' .env | xargs)
chmod +x script/*.sh

• build: make all
• run: make run or ./script/run.sh
• make iso: ./script/geniso.sh

edit the fs files

• first mount the disk device

./script/mount-device.sh
cd mnt/

• then do some stuffs in mnt/
• finally unmount. you also want to run this if you ever encounter errors like disk image is in use or whatever

./script/umount-device.sh

• if you want to copy some files/dirs and dont want to run mount-device and then umount-device

./script/cpyfile.sh file/or/directory/in/somewhere ./mnt/some/DIRECTORY/in/the/disk

Files and directories in fsfiles/ will be automatically copied into the disk image after running make all.

Running on real hardware

You can either make an iso ./script/geniso.sh and burn it to an usb or use sudo dd if=disk.img of=/dev/sdX && sync to burn the disk to an usb to run the OS.

Caution

• I am not responsible for any damage caused to your machine by the OS. Try this with your own risk!
• I do not test the runability of the OS on every commits so don't expect it to run normaly. Also i do not own many pc to test properly so it maybe only works on my pc.

Learning resources

Tip

Anything related to osdev can be found on the osdev wiki

Great tutorials

• https://www.cs.bham.ac.uk/~exr/lectures/opsys/10_11/lectures/os-dev.pdf
• http://www.osdever.net/bkerndev/Docs/gettingstarted.htm
• http://www.brokenthorn.com/Resources/OSDevIndex.html
• https://web.archive.org/web/20160313134414/http://www.jamesmolloy.co.uk/tutorial_html/index.html

Documents

• https://www.intel.com/content/www/us/en/developer/articles/technical/intel-sdm.html
• https://www.gnu.org/software/grub/manual/multiboot/multiboot.html
• https://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/fatgen103.doc
• http://www.skyfree.org/linux/references/ELF_Format.pdf