Go to file
Malo Lecomte 90a6ebafe9 feat(iso): add seek function 2022-04-24 02:43:52 +02:00
k feat(iso): add seek function 2022-04-24 02:43:52 +02:00
libs feat: add given files 2021-07-12 15:57:08 +02:00
roms feat: add given files 2021-07-12 15:57:08 +02:00
tools feat: add given files 2021-07-12 15:57:08 +02:00
.bochsrc feat(bochsrc): add magic breakpoints for bochs 2021-07-14 03:15:58 +02:00
.gitignore feat(serial): add serial initialization and gitignore 2021-07-12 19:46:21 +02:00
config.mk feat: add given files 2021-07-12 15:57:08 +02:00
Makefile feat: add given files 2021-07-12 15:57:08 +02:00
README.md feat: add given files 2021-07-12 15:57:08 +02:00


This is the student code for the kernel course at EPITA.

Table of contents

  1. Checkout out
    1. The tarball
    2. Dependancies
    3. Source tree
    4. Intel Manuals
  2. Build System
  3. Booting your kernel
  4. Debugging your kernel

Checking out

The tarball

A readonly git repository given by the LSE can be cloned:

git clone git@github.com:lse/k.git

Dependancies for building

  • gcc-multilib
  • grub2
  • libisoburn
  • find

Source tree

Here is the description of some important files:

Makefile            # top-level Makefile
config.mk           # build-system configuration
k                   # kernel source folder
k/elf.h             # ELF header
k/crt0.S            # crt0 for the kernel
k/k.c               # kernel entry point
k/multiboot.h       # Multiboot Specification header
k/k.lds             # LD script for the kernel binary
k/memory.c          # kernel memory allocator
k/include/k/atapi.h # ATAPI related definitions
k/include/k/kstd.h  # k standard definitions
k/include/k/kfs.h   # KFS structures definitions
k/include/k/types.h # kernel types definitions
roms                # rom folder
roms/chichepong     # chichepong folder
roms/roms.lds       # LD script for rom binaries
libs                # SDK folder
libs/libc           # a basic libc available everywhere
libs/libk           # userland functions
tools               # Tools folder
tools/mkksf         # small program to generate your own sounds
tools/mkkfs         # small program to create kfs roms
tools/create-iso.sh # small tool to generate the iso image

Intel Manuals

You will find the essential Intel Manuals describing the processor, all the instructions as well as the programming guide on the intel website.

The most interesting one is probably the "Volume 3A: System Programming Guide" which describe everything that is needed to develop an operating system.

Build System

The build system uses information stored in config.mk. Feel free to modify this file, but your project must work with the original one.

Here are make rules you need to know:

make | make k.iso  # create an ISO with all the roms
make k             # compile your kernel
make rom/GAME      # compile the rom in the folder rom/$(GAME)
make clean         # clean the tree

Booting your kernel in qemu

qemu-system-x86_64 -cdrom k.iso [ -enable-kvm ]

Debugging your kernel

Build your kernel with debug flags.

  • Run QEMU with a gdb server and stop the CPU at the first instruction:
    qemu-system-x86_64 -cdrom k.iso -s -S
  • Run gdb with your kernel binary:
gdb k/k
  • Once in gdb, connect to QEMU:
target remote localhost:1234
  • Add some breakpoints:
b my_symbol
  • Run the simulation in gdb: