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.
24 # THESE MUST MATCH WHAT IS DEFINED IN defs.h and defs.asm exactly
25 # MUST BE INTEGRAL NUMBER OF PAGES
26 TOP_OF_MEM := 0x30000000
31 # THE KERNEL, SETUP, BOOTPACKAGE MUST BE SMALLER THAN THIS
32 # MUST BE INTEGRAL NUMBER OF PAGES
36 # Base address of kernel
38 # Note: at top of memory minus three pages (GDT/TSS/IDT)
42 # Note that the code will initially load at 0x10000
44 # The setup code needs to copy it up to this address and jump there
46 KERNEL_BASE_ADDR := $(shell perl -e 'print sprintf("0x%x",$(TOP_OF_MEM)-4096*3-$(MAX_VMM));')
48 # Kernel entry point function
49 KERNEL_ENTRY = $(SYM_PFX)Main
53 VPATH := $(PROJECT_ROOT)/src
55 #when -DNDEBUG is set the kassert functions are disabled
57 JRLDEBUG= -DSERIAL_PRINT_DEBUG=1 -DSERIAL_PRINT_DEBUG_LEVEL=10 -DSERIAL_PRINT=1
61 #Peter's compile flags
62 PADFLAGS = -DMAX_VMM=$(MAX_VMM)
64 # Figure out if we're compiling with cygwin, http://cygwin.com
65 SYSTEM_NAME := $(shell uname -s)
66 ifeq ($(findstring CYGWIN,$(SYSTEM_NAME)),CYGWIN)
68 EXTRA_C_OPTS := -DNEED_UNDERSCORE -DGNU_WIN32
69 EXTRA_NASM_OPTS := -DNEED_UNDERSCORE
71 EXTRA_CC_USER_OPTS := -Dmain=geekos_main
74 VMM_SIZES = ../include/geekos/vmm_sizes.h
77 # ----------------------------------------------------------------------
79 # Various options specifying how GeekOS should be built,
80 # what source files to build, which user programs to build,
81 # etc. This is generally the only section of the makefile
82 # that will need to be modified.
83 # ----------------------------------------------------------------------
85 # List of targets to build by default.
86 # These targets encompass everything needed to boot
88 ALL_TARGETS := fd.img vm_kernel
92 KERNEL_C_SRCS := idt.c int.c trap.c irq.c io.c \
94 keyboard.c screen.c timer.c \
96 gdt.c tss.c segment.c \
100 paging.c vmx.c vmcs_gen.c vmcs.c \
101 svm.c vmm.c vmm_util.c vmm_stubs.c \
102 vmcb.c vmm_mem.c vm_guest.c \
106 # Kernel object files built from C source files
107 KERNEL_C_OBJS := $(KERNEL_C_SRCS:%.c=geekos/%.o)
109 # Kernel assembly files
110 KERNEL_ASM_SRCS := lowlevel.asm vmx_lowlevel.asm svm_lowlevel.asm
112 KERNEL_GAS_SRCS := testvm.s
114 # Kernel object files build from assembler source files
115 KERNEL_ASM_OBJS := $(KERNEL_ASM_SRCS:%.asm=geekos/%.o)
117 KERNEL_GAS_OBJS := $(KERNEL_GAS_SRCS:%.s=geekos/%.o)
120 # All kernel object files
121 KERNEL_OBJS := $(KERNEL_C_OBJS) \
122 $(KERNEL_ASM_OBJS) $(KERNEL_GAS_OBJS)
124 # Common library source files.
125 # This library is linked into both the kernel and user programs.
126 # It provides string functions and generic printf()-style
128 COMMON_C_SRCS := fmtout.c string.c memmove.c
130 # Common library object files.
131 COMMON_C_OBJS := $(COMMON_C_SRCS:%.c=common/%.o)
136 # ----------------------------------------------------------------------
138 # This section defines programs that are used to build GeekOS.
139 # ----------------------------------------------------------------------
141 # Uncomment if cross compiling
142 TARGET_CC_PREFIX := $(PROJECT_ROOT)/../devtools/i386/bin/i386-elf-
143 #TARGET_CC_PREFIX := i386-elf-
145 # Target C compiler. gcc 2.95.2 or later should work.
146 TARGET_CC := $(TARGET_CC_PREFIX)gcc
147 #TARGET_CC := $(TARGET_CC_PREFIX)gcc34 -m32
149 # Host C compiler. This is used to compile programs to execute on
150 # the host platform, not the target (x86) platform. On x86/ELF
151 # systems, such as Linux and FreeBSD, it can generally be the same
152 # as the target C compiler.
155 # Target linker. GNU ld is probably to only one that will work.
156 TARGET_LD := $(TARGET_CC_PREFIX)ld -melf_i386
159 TARGET_AR := $(TARGET_CC_PREFIX)ar
162 TARGET_RANLIB := $(TARGET_CC_PREFIX)ranlib
165 TARGET_NM := $(TARGET_CC_PREFIX)nm
168 TARGET_OBJCOPY := $(TARGET_CC_PREFIX)objcopy
170 # Nasm (http://nasm.sourceforge.net)
171 NASM := $(PROJECT_ROOT)/../devtools/bin/nasm
172 #NASM := /opt/vmm-tools/bin/nasm
176 # Tool to build PFAT filesystem images.
177 BUILDFAT := tools/builtFat.exe
182 # Pad a file so its size is a multiple of some unit (i.e., sector size)
183 PAD := $(PERL) $(PROJECT_ROOT)/scripts/pad
185 # Create a file filled with zeroes.
186 ZEROFILE := $(PERL) $(PROJECT_ROOT)/scripts/zerofile
188 # Calculate size of file in sectors
189 NUMSECS := $(PERL) $(PROJECT_ROOT)/scripts/numsecs
192 # ----------------------------------------------------------------------
194 # Options passed to the tools.
195 # ----------------------------------------------------------------------
197 # Flags used for all C source files
198 GENERAL_OPTS := -O -Wall $(EXTRA_C_OPTS) $(JRLDEBUG) $(PADFLAGS)
199 CC_GENERAL_OPTS := $(GENERAL_OPTS) -Werror
201 # Flags used for kernel C source files
202 CC_KERNEL_OPTS := -g -DGEEKOS -I$(PROJECT_ROOT)/include
204 # Flags user for kernel assembly files
205 NASM_KERNEL_OPTS := -I$(PROJECT_ROOT)/src/geekos/ -f elf $(EXTRA_NASM_OPTS)
207 # Flags used for common library and libc source files
208 CC_USER_OPTS := -I$(PROJECT_ROOT)/include -I$(PROJECT_ROOT)/include/libc \
209 $(EXTRA_CC_USER_OPTS)
211 # Flags passed to objcopy program (strip unnecessary sections from kernel.exe)
212 OBJCOPY_FLAGS := -R .dynamic -R .note -R .comment
214 # ----------------------------------------------------------------------
216 # Describes how to compile the source files.
217 # ----------------------------------------------------------------------
219 # Compilation of kernel C source files
221 geekos/%.o : geekos/%.c
222 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
225 # Compilation of kernel assembly source files
226 geekos/%.o : geekos/%.asm
227 $(NASM) $(NASM_KERNEL_OPTS) $< -o geekos/$*.o
229 # Compilation of test VM
230 geekos/%.o : geekos/%.s
231 $(AS) $< -o geekos/$*.o
233 geekos/%.o : geekos/%.S
234 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) $< -o geekos/$*.o
236 # Compilation of common library C source files
237 common/%.o : common/%.c
238 $(TARGET_CC) -c $(CC_GENERAL_OPTS) $(CC_USER_OPTS) $< -o common/$*.o
240 # ----------------------------------------------------------------------
242 # Specifies files to be built
243 # ----------------------------------------------------------------------
245 # Default target - see definition of ALL_TARGETS in Configuration section
249 geekos/vmx_lowlevel.o: $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm
252 -I$(PROJECT_ROOT)/src/geekos/ \
253 $(PROJECT_ROOT)/src/geekos/vmx_lowlevel.asm \
257 geekos/test: geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o
258 $(CC) geekos/test.o geekos/vmcs.o geekos/vmx_lowlevel.o -o geekos/test
260 # Standard floppy image - just boots the kernel
261 fd.img : geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin vm_kernel
262 cat geekos/fd_boot.bin geekos/setup.bin geekos/kernel.bin > _temp
264 cat _temp vm_kernel > $@
266 # make ready to boot over PXE
268 cp fd.img /tftpboot/vmm.img
269 $(PAD) /tftpboot/vmm.img 1474560
273 # Floppy boot sector (first stage boot loader).
274 geekos/fd_boot.bin : geekos/setup.bin geekos/kernel.bin $(PROJECT_ROOT)/src/geekos/fd_boot.asm vm_kernel
276 -I$(PROJECT_ROOT)/src/geekos/ \
277 -DNUM_SETUP_SECTORS=`$(NUMSECS) geekos/setup.bin` \
278 -DNUM_KERN_SECTORS=`$(NUMSECS) geekos/kernel.bin` \
279 -DNUM_VM_KERNEL_SECTORS=`$(NUMSECS) vm_kernel` \
280 $(PROJECT_ROOT)/src/geekos/fd_boot.asm \
283 # Setup program (second stage boot loader).
284 geekos/setup.bin : geekos/kernel.exe $(PROJECT_ROOT)/src/geekos/setup.asm
286 -I$(PROJECT_ROOT)/src/geekos/ \
287 -DENTRY_POINT=0x`egrep 'Main$$' geekos/kernel.syms |awk '{print $$1}'` \
288 -DVMM_FINAL_ADDR=$(KERNEL_BASE_ADDR) \
289 -DVMM_SIZE=$(MAX_VMM) \
290 $(PROJECT_ROOT)/src/geekos/setup.asm \
294 # Loadable (flat) kernel image.
295 geekos/kernel.bin : geekos/kernel.exe
296 $(TARGET_OBJCOPY) $(OBJCOPY_FLAGS) -S -O binary geekos/kernel.exe geekos/kernel.bin
299 # The kernel executable and symbol map.
300 geekos/kernel.exe : $(KERNEL_OBJS) $(COMMON_C_OBJS)
301 $(TARGET_LD) -o geekos/kernel.exe -Ttext $(KERNEL_BASE_ADDR) -e $(KERNEL_ENTRY) \
302 $(KERNEL_OBJS) $(COMMON_C_OBJS)
303 $(TARGET_NM) geekos/kernel.exe > geekos/kernel.syms
306 generate_sizes: force
307 echo "#ifndef __vmm_sizes" > $(VMM_SIZES)
308 echo "#define __vmm_sizes" >> $(VMM_SIZES)
309 echo "#define KERNEL_LOAD_ADDRESS " $(KERNEL_BASE_ADDR) >> $(VMM_SIZES)
311 echo "#define KERNEL_START (KERNEL_LOAD_ADDRESS)" >> $(VMM_SIZES)
312 echo "#define KERNEL_CORE_LENGTH (" `$(NUMSECS) geekos/kernel.bin` "*512)" >> $(VMM_SIZES)
313 echo "#define KERNEL_END (KERNEL_LOAD_ADDRESS+KERNEL_CORE_LENGTH-1)" >> $(VMM_SIZES)
315 echo "#define VM_KERNEL_LENGTH (" `$(NUMSECS) vm_kernel` "*512)" >> $(VMM_SIZES)
316 echo "#define VM_KERNEL_START (KERNEL_LOAD_ADDRESS + KERNEL_CORE_LENGTH)" >> $(VMM_SIZES)
317 echo "#define VM_BOOT_PACKAGE_START (VM_KERNEL_START) " >> $(VMM_SIZES)
318 echo "#define VM_BOOT_PACKAGE_END (VM_KERNEL_START+VM_KERNEL_LENGTH-1) " >> $(VMM_SIZES)
319 echo "#endif" >> $(VMM_SIZES)
321 make_show_sizes: generate_sizes ../src/geekos/show_sizes.c
322 $(HOST_CC) -I../include/geekos ../src/geekos/show_sizes.c -o show_sizes
324 show_sizes: make_show_sizes
328 get_kernel_size: make_show_sizes
336 @echo "VM kernel lives at 0x100000 and is" `$(NUMSECS) vm_kernel` "sectors long"
340 vmm_mem_test: geekos/vmm_mem.c
341 $(HOST_CC) -o mem_test -DVMM_MEM_TEST -I../include ../src/geekos/vmm_mem.c
344 # Clean build directories of generated files
346 for d in geekos common libc user tools; do \
347 (cd $$d && rm -f *); \
351 # Build header file dependencies, so source files are recompiled when
352 # header files they depend on are modified.
353 depend : $(GENERATED_LIBC_SRCS)
354 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_KERNEL_OPTS) \
355 $(KERNEL_C_SRCS:%.c=$(PROJECT_ROOT)/src/geekos/%.c) \
356 | $(PERL) -n -e 's,^(\S),geekos/$$1,;print' \
358 $(TARGET_CC) -M $(CC_GENERAL_OPTS) $(CC_USER_OPTS) \
359 $(COMMON_C_SRCS:%.c=$(PROJECT_ROOT)/src/common/%.c) \
360 | $(PERL) -n -e 's,^(\S),common/$$1,;print' \
363 # By default, there are no header file dependencies.