Makefile

# 	NOTES
#
# 	bin/disk.img is the flat hard disk that the emulator will see
#
#	SPECIAL VARIABLES REFERENCE
#	$^ = name of all the dependencies with space as the delimiter
#	$@ = full target name of the current target
#	$< = name of the first dependency
#	$? = returns the dependencies that are newer than the current target
#	$* = returns the text that corresponds to % in the target

export PREFIX := $(HOME)/opt/cross
export TARGET := i686-elf
export PATH := $(PREFIX)/bin:$(PATH)

MAKEFILE_DIR := $(CURDIR)

SHELL = /bin/sh
INCLUDES = ./src
MODULES = build/kernel.asm.o build/kernel.o \
	build/print.o build/idt/idt.asm.o \
	build/idt/idt.o build/memory/memory.o \
	build/io/io.asm.o  build/memory/heap/heap.o \
	build/memory/heap/kernel_heap.o build/memory/paging/paging.o \
	build/memory/paging/paging.asm.o build/disk/disk.o \
	build/string/string.o build/fs/pparser.o \
	build/disk/disk_stream.o build/fs/file.o \
	build/fs/fat/fat16.o \
	build/gdt/gdt.o build/gdt/gdt.asm.o \
	build/task/tss.asm.o build/task/task.o \
	build/task/process.o build/task/task.asm.o \
	build/isr80h/isr80h.o build/isr80h/misc.o \
	build/isr80h/io.o build/isr80h/heap.o build/isr80h/process.o \
	build/keyboard/keyboard.o build/keyboard/ps2_keyboard.o \
	build/loader/formats/elf_file.o

FLAGS = -g -ffreestanding -falign-jumps -falign-functions -falign-labels \
	-falign-loops -fstrength-reduce -fomit-frame-pointer \
	-finline-functions -Wno-unused-function -fno-builtin \
	-Werror -Wno-unused-label -Wno-cpp -Wno-unused-parameter \
	-nostdlib -nostartfiles -nodefaultlibs -Wall -O0 -Iinc

USER_PROG_1_FOLDER = test_sum_syscall
USER_PROG_1 = sum
USER_PROG_2_FOLDER = test_print_syscall
USER_PROG_2 = print
USER_PROG_3_FOLDER = test_elf_loader
USER_PROG_3 = print
USER_PROG_4_FOLDER = test_stdlib
USER_PROG_4 = tstlib
USER_PROG_5_FOLDER = shell
USER_PROG_5 = shell
USER_PROG_6_FOLDER = echo
USER_PROG_6 = echo

# Testing out Rust integration. I may write new features in Rust going forward.
RUST_LIB_DIR = rust-coniferos/target/i686-unknown-none/release
RUST_LIB = -l:librust_coniferos.a
RUST_LIB_FILE = $(RUST_LIB_DIR)/librust_coniferos.a
RUST_INTERFACE_H = rust_coniferos.h

all: user_programs bin/disk.img

bin/disk.img: bin/os.bin
	cp bin/os.bin bin/disk.img
#	Mount and unmount the the disk image as a file system
#	This will allow us to copy over files onto the disk image
	sudo mount -t vfat bin/disk.img /mnt/d
	echo "Hello World" > ./hello.txt
	sudo cp ./hello.txt /mnt/d
#	TODO: find a better way of building and copying user programs to the filesystem
	sudo cp ./user_programs/$(USER_PROG_1_FOLDER)/$(USER_PROG_1).bin /mnt/d
	sudo cp ./user_programs/$(USER_PROG_2_FOLDER)/$(USER_PROG_2).bin /mnt/d
	sudo cp ./user_programs/$(USER_PROG_3_FOLDER)/$(USER_PROG_3).elf /mnt/d
	sudo cp ./user_programs/$(USER_PROG_4_FOLDER)/$(USER_PROG_4).elf /mnt/d
	sudo cp ./user_programs/$(USER_PROG_5_FOLDER)/build/$(USER_PROG_5).elf /mnt/d
	sudo cp ./user_programs/$(USER_PROG_6_FOLDER)/build/$(USER_PROG_6).elf /mnt/d
	sudo umount /mnt/d

# os.bin is a concatenation of the boot binary and the kernel binary.
bin/os.bin: bin/boot.bin bin/kernel.bin
	dd if=bin/boot.bin > bin/os.bin
	dd if=bin/kernel.bin >> bin/os.bin
	dd if=/dev/zero bs=1048576 count=16 >> bin/os.bin # Fills up rest of disk with 16, 1 MB sized blocks of zeros (this will be used by Linux to store our file data)

# kernel.bin is the binary file which contains all the kernel code
bin/kernel.bin: $(RUST_LIB_FILE) $(MODULES)
	i686-elf-gcc $(FLAGS) -ffreestanding -O0 -nostdlib  -T src/linker.ld $(MODULES) -L$(RUST_LIB_DIR) $(RUST_LIB) -o bin/kernel.elf
	i686-elf-objcopy -O binary bin/kernel.elf bin/kernel.bin

$(RUST_LIB_FILE):
	cd rust-coniferos && cargo build --release && cp ${RUST_INTERFACE_H} ${MAKEFILE_DIR}/src/rust_interface/

# boot.bin contains our bootloader code, and is what loads the kernel into memory.
bin/boot.bin: src/boot/boot.asm
	nasm -f bin $^ -o $@

build/kernel.asm.o:  src/kernel.asm
	nasm -f elf -g $^ -o $@

build/kernel.o: src/kernel.c
	i686-elf-gcc -I $(INCLUDES) $(FLAGS) -c $^ -o $@

build/print.o: src/print/print.c
	i686-elf-gcc -I $(INCLUDES) src/print $(FLAGS) -c $^ -o $@

build/idt/idt.asm.o:  src/idt/idt.asm
	nasm -f elf -g $^ -o $@

build/idt/idt.o: src/idt/idt.c
	i686-elf-gcc -I $(INCLUDES) src/idt $(FLAGS) -c $^ -o $@

build/isr80h/isr80h.o: src/isr80h/isr80h.c
	i686-elf-gcc -I $(INCLUDES) src/isr80h $(FLAGS) -c $^ -o $@

build/isr80h/misc.o: src/isr80h/misc.c
	i686-elf-gcc -I $(INCLUDES) src/isr80h $(FLAGS) -c $^ -o $@

build/isr80h/io.o: src/isr80h/io.c
	i686-elf-gcc -I $(INCLUDES) src/isr80h $(FLAGS) -c $^ -o $@

build/isr80h/heap.o: src/isr80h/heap.c
	i686-elf-gcc -I $(INCLUDES) src/isr80h $(FLAGS) -c $^ -o $@

build/isr80h/process.o: src/isr80h/process.c
	i686-elf-gcc -I $(INCLUDES) src/isr80h $(FLAGS) -c $^ -o $@

build/gdt/gdt.asm.o:  src/gdt/gdt.asm
	nasm -f elf -g $^ -o $@

build/gdt/gdt.o: src/gdt/gdt.c
	i686-elf-gcc -I $(INCLUDES) src/gdt $(FLAGS) -c $^ -o $@

build/memory/memory.o: src/memory/memory.c
	i686-elf-gcc -I $(INCLUDES) src/memory $(FLAGS) -c $^ -o $@

build/io/io.asm.o:  src/io/io.asm
	nasm -f elf -g $^ -o $@

build/task/task.o: src/task/task.c
	i686-elf-gcc -I $(INCLUDES) src/task $(FLAGS) -c $^ -o $@

build/task/task.asm.o: src/task/task.asm
	nasm -f elf -g $^ -o $@

build/task/process.o: src/task/process.c
	i686-elf-gcc -I $(INCLUDES) src/task $(FLAGS) -c $^ -o $@

build/task/tss.asm.o:  src/task/tss.asm
	nasm -f elf -g $^ -o $@

build/memory/heap/heap.o: src/memory/heap/heap.c
	i686-elf-gcc -I $(INCLUDES) src/memory/heap $(FLAGS) -c $^ -o $@

build/memory/heap/kernel_heap.o: src/memory/heap/kernel_heap.c
	i686-elf-gcc -I $(INCLUDES) src/memory/heap $(FLAGS) -c $^ -o $@

build/memory/paging/paging.o: src/memory/paging/paging.c
	i686-elf-gcc -I $(INCLUDES) src/memory/paging $(FLAGS) -c $^ -o $@

build/memory/paging/paging.asm.o:  src/memory/paging/paging.asm
	nasm -f elf -g $^ -o $@

build/disk/disk.o: src/disk/disk.c
	i686-elf-gcc -I $(INCLUDES) src/disk $(FLAGS) -c $^ -o $@

build/string/string.o: src/string/string.c
	i686-elf-gcc -I $(INCLUDES) src/string $(FLAGS) -c $^ -o $@

build/fs/pparser.o: src/fs/pparser.c
	i686-elf-gcc -I $(INCLUDES) src/fs $(FLAGS) -c $^ -o $@

build/fs/file.o: src/fs/file.c
	i686-elf-gcc -I $(INCLUDES) src/fs $(FLAGS) -c $^ -o $@

build/fs/fat/fat16.o: src/fs/fat/fat16.c
	i686-elf-gcc -I $(INCLUDES) src/fs/fat $(FLAGS) -c $^ -o $@

build/disk/disk_stream.o: src/disk/disk_stream.c
	i686-elf-gcc -I $(INCLUDES) src/disk $(FLAGS) -c $^ -o $@

build/keyboard/keyboard.o: src/keyboard/keyboard.c
	i686-elf-gcc -I $(INCLUDES) src/keyboard $(FLAGS) -c $^ -o $@

build/keyboard/ps2_keyboard.o: src/keyboard/ps2_keyboard.c
	i686-elf-gcc -I $(INCLUDES) src/keyboard $(FLAGS) -c $^ -o $@

build/loader/formats/elf_file.o: src/loader/formats/elf_file.c
	i686-elf-gcc -I $(INCLUDES) src/loader/formats $(FLAGS) -c $^ -o $@

.PHONY: run
run:
	qemu-system-i386 -drive file=bin/disk.img,index=0,media=disk,format=raw

.PHONY: runcurses
runcurses:
	qemu-system-i386 -drive file=bin/disk.img,index=0,media=disk,format=raw -curses

.PHONY: killcurses
killcurses:
	pkill qemu

.PHONY: debug
debug:
	qemu-system-i386 -s -S -hda ./bin/disk.img

.PHONY: debug_curses
debug_curses:
	qemu-system-i386 -s -S -hda ./bin/disk.img -curses

.PHONY: run_no_restart
run_no_restart:
	qemu-system-i386 --no-reboot -d int --no-shutdown -drive file=bin/disk.img,index=0,media=disk,format=raw

# Build userland programs
.PHONY: user_programs
user_programs:
	cd ./user_programs/stdlib && $(MAKE) all
	cd ./user_programs/$(USER_PROG_1_FOLDER) && $(MAKE) all
	cd ./user_programs/$(USER_PROG_2_FOLDER) && $(MAKE) all
	cd ./user_programs/$(USER_PROG_3_FOLDER) && $(MAKE) all
	cd ./user_programs/$(USER_PROG_4_FOLDER) && $(MAKE) all
	cd ./user_programs/$(USER_PROG_5_FOLDER) && $(MAKE) all
	cd ./user_programs/$(USER_PROG_6_FOLDER) && $(MAKE) all

# Clean userland programs
.PHONY: user_programs_clean
user_programs_clean:
	cd ./user_programs/stdlib && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_1_FOLDER) && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_2_FOLDER) && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_3_FOLDER) && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_4_FOLDER) && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_5_FOLDER) && $(MAKE) clean
	cd ./user_programs/$(USER_PROG_6_FOLDER) && $(MAKE) clean

.PHONY: rust_clean
rust_clean:
	cd rust-coniferos && cargo clean

.PHONY: clean
clean: user_programs_clean rust_clean
	rm -rf bin/boot.bin
	rm -rf bin/kernel.bin
	rm -rf bin/os.bin
	rm -rf ${MODULES}
	rm -rf bin/disk.img
	rm -rf ./hello.txt

.PHONY: attach_gdb
attach_gdb:
	gdb -ex "target remote localhost:1234" -ex "add-symbol-file bin/kernel.elf 0x100000" -ex "directory src"
	
# Generate a clangd config
.PHONY: clangd_config
clangd_config:
	bear --output compile_commands.json -- ./scripts/build.sh