1 # Makefile for GeekOS kernel, userspace, and tools
2 # Copyright (c) 2004,2005 David H. Hovemeyer <daveho@cs.umd.edu>
5 # This is free software. You are permitted to use,
6 # redistribute, and modify it as specified in the file "COPYING".
8 # Required software to build GeekOS:
9 # - GNU Make (http://www.gnu.org/software/make)
10 # - gcc 2.95.2 generating code for target (i386/ELF) and host platforms
11 # - nasm (http://nasm.sourceforge.net)
12 # - Perl5, AWK (any version), egrep
14 # Cygwin (http://cygwin.com) may be used to build GeekOS.
15 # Make sure that gcc, binutils, nasm, and perl are installed.
18 # - This makefile has been written carefully to work correctly
19 # with the -j (parallel make) option. I regularly use "make -j 2"
20 # to speed the build process on 2 processor systems.
22 # Base address of kernel
24 # Note: at top of memory minus three pages (GDT/TSS/IDT)
28 # Note that the code will initially load at 0x10000
30 # The setup code needs to copy it up to this address and jump there
32 KERNEL_BASE_ADDR := 0x100000
34 # Kernel entry point function
35 KERNEL_ENTRY = $(SYM_PFX)Main
39 VPATH := $(PROJECT_ROOT)/src
41 ifeq ($(DEBUG_SERIAL),1)
42 JRL_DEBUG := -DDEBUG_SERIAL
47 # Figure out if we're compiling with cygwin, http://cygwin.com
48 SYSTEM_NAME := $(shell uname -s)
49 ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
51 EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
52 EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
54 EXTRA_CC_USER_OPTS := -Dmain=geekos_main
59 # ----------------------------------------------------------------------
61 # Various options specifying how GeekOS should be built,
62 # what source files to build, which user programs to build,
63 # etc. This is generally the only section of the makefile
64 # that will need to be modified.
65 # ----------------------------------------------------------------------
67 # List of targets to build by default.
68 # These targets encompass everything needed to boot
70 ALL_TARGETS := geekos/kernel.bin fd.img
74 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
76 keyboard.c screen.c timer.c \
78 gdt.c tss.c segment.c \
85 # Kernel object files built from C source files
86 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
88 # Kernel assembly files
89 KERNEL_ASM_SRCS := lowlevel.asm
93 # Kernel object files build from assembler source files
94 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
96 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
99 # All kernel object files
100 KERNEL_OBJS := $(KERNEL_C_OBJS) \
101 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
103 # Common library source files.
104 # This library is linked into both the kernel and user programs.
105 # It provides string functions and generic printf()-style
107 COMMON_C_SRCS := fmtout.c string.c memmove.c
109 # Common library object files.
110 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
115 # ----------------------------------------------------------------------
117 # This section defines programs that are used to build GeekOS.
118 # ----------------------------------------------------------------------
120 # Uncomment if cross compiling
121 #TARGET_CC_PREFIX := i386-elf-
122 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../../devtools/i386/bin/i386-elf-
124 # Target C compiler. gcc 2.95.2 or later should work.
125 TARGET_CC := $(TARGET_CC_PREFIX)gcc
128 # Host C compiler. This is used to compile programs to execute on
129 # the host platform, not the target (x86) platform. On x86/ELF
130 # systems, such as Linux and FreeBSD, it can generally be the same
131 # as the target C compiler.
134 # Target linker. GNU ld is probably to only one that will work.
135 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
138 TARGET_AR := $(TARGET_CC_PREFIX)ar
141 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
144 TARGET_NM := $(TARGET_CC_PREFIX)nm
147 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
149 # Nasm (http://nasm.sourceforge.net)
150 NASM := $(PROJECT_ROOT)/../../devtools/bin/nasm
151 #NASM := /opt/vmm-tools/bin/nasm
155 # Tool to build PFAT filesystem images.
156 BUILDFAT := tools/builtFat.exe
161 # Pad a file so its size is a multiple of some unit (i.e., sector size)
162 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
164 # Create a file filled with zeroes.
165 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
167 # Calculate size of file in sectors
168 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
171 # ----------------------------------------------------------------------
173 # Options passed to the tools.
174 # ----------------------------------------------------------------------
176 # Flags used for all C source files
177 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(JRL_DEBUG)
178 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
180 # Flags used for kernel C source files
181 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
183 # Flags user for kernel assembly files
184 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
186 # Flags used for common library and libc source files
187 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
188 $(EXTRA_CC_USER_OPTS)
190 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
191 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
193 # ----------------------------------------------------------------------
195 # Describes how to compile the source files.
196 # ----------------------------------------------------------------------
198 # Compilation of kernel C source files
200 geekos/%.o : geekos/%.c
201 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
204 # Compilation of kernel assembly source files
205 geekos/%.o : geekos/%.asm
206 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
208 # Compilation of test VM
209 geekos/%.o : geekos/%.s
210 $(AS) $< -o geekos/$*.o
212 geekos/%.o : geekos/%.S
213 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
215 # Compilation of common library C source files
216 common/%.o : common/%.c
217 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
219 # ----------------------------------------------------------------------
221 # Specifies files to be built
222 # ----------------------------------------------------------------------
224 # Default target - see definition of ALL_TARGETS in Configuration section
227 # Standard floppy image - just boots the kernel
228 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin
229 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > $@
235 $(PAD) guest.img 1474560
239 mkisofs -pad -b guest.img -R -o guest.iso guest.img
243 # Floppy boot sector (first stage boot loader).
244 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm
246 -I$(PROJECT_ROOT)/src/geekos/ \
247 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
248 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
249 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
252 # Setup program (second stage boot loader).
253 geekos/setup.bin : geekos/kernel.exe $(PROJECT_ROOT)/src/geekos/setup.asm
255 -I$(PROJECT_ROOT)/src/geekos/ \
256 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
257 $(PROJECT_ROOT)/src/geekos/setup.asm \
262 # Loadable (flat) kernel image.
263 geekos/kernel.bin : geekos/kernel.exe
264 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
267 # The kernel executable and symbol map.
268 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS)
269 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
270 $(KERNEL_OBJS) $(COMMON_C_OBJS)
271 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
279 # Clean build directories of generated files
281 for d in geekos common libc user tools; do \
282 (cd $$d && rm -f *); \
286 # Build header file dependencies, so source files are recompiled when
287 # header files they depend on are modified.
288 depend : $(GENERATED_LIBC_SRCS)
289 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
290 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
291 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
293 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
294 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
295 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
298 # By default, there are no header file dependencies.